2f762c9d95 | ||
---|---|---|
LICENSE.txt | ||
README.md | ||
banner.png | ||
puml-mode.el |
README.md
PlantUML mode for Emacs
NOTE: This is currently almost only a GitHub mirror of the nice job done by Zhang Weize as I couldn't find anything like a source repository. Just minor changes were introduced.
Provides a PlantUml major mode for Emacs.
Installation
Make sure you have MELPA enabled in your emacs.d
. Then, you can just
M-x package-install<RET>
puml-mode<RET>
Enjoy!
Features
- Syntax highlight
- Autocompletion
- Preview
Enable the major mode
You can automatically enable puml-mode
for files with extension .puml
or plantuml
by adding the following to your .emacsrc
:
;; Enable puml-mode for PlantUML files
(add-to-list 'auto-mode-alist
'("\\.puml\\'" . puml-mode)
'("\\.plantuml\\'" . puml-mode))
Of course, you can always enable manually the major mode by typing M-x puml-mode
once in the desired PlantUML file buffer.
Usage
You can either tell puml-mode
to autocomplete the word before the cursor by typing M-x puml-complete-symbol
. This will open a popup with all the available completions as found in the list of keywords given by running PlantUML with the -language
flag.
To render the PlantUML diagram within Emacs, you can also hit M-x puml-preview
. This will run PlantUML and display the result in the *PUML-Preview*
buffer. The format used to render the diagram is automagically chosen from what's supported by your Emacs. It will be one of the following, in order of preference:
- SVG
PNGstill unsupported, see #6- Unicode ASCII art
Default key bindings
The following shortcuts are enabled by default:
C-c C-c renders a PlantUML diagram from the current buffer in the best supported format
License
Released under the terms of GPLv2. See LICENSE.txt.