This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/plantuml
Robert O'Connor 7d82e576ab Add plantuml layer
Adds support for PlanetUML, a tool to generate
UML diagrams from plain text.
2016-02-01 00:07:54 -05:00
..
img Add plantuml layer 2016-02-01 00:07:54 -05:00
packages-config.el Add plantuml layer 2016-02-01 00:07:54 -05:00
packages.el Add plantuml layer 2016-02-01 00:07:54 -05:00
README.org Add plantuml layer 2016-02-01 00:07:54 -05:00

plantuml layer

/TakeV/spacemacs/media/commit/055481a7951856edc06e09057b215daa6fc246ba/layers/+lang/plantuml/img/logo.png

Description

This layer enables support for puml-mode, which provides a major-mode for plantuml. PlantUML is a tool to generate UML diagrams from plain-text.

For help with how to use plantuml, see the plantuml website and the reference guide.

The official file extension supported by this layer is .pum. If you want something else, set it in your user-config function of your ~/.spacemacs file.

For example, the following diagram can be defined as follows:

@startuml
JAremko->robbyoconnor : I think the docs can benefit from some kind of illustration
JAremko<-robbyoconnor : I'm too lazy -- I have actual work to do. I link to the docs. If you can write me a diagram in plantuml, I'll gladly compile and add it.
JAremko->robbyoconnor : *gives ths diagram*
robbyoconnor<-JAremko : *robbyoconnor adds it and JAremko is happy*
...
robbyoconnor->theOtherPerson : And they thinks it's funny? Yup, they definitely finds it funny. Right?
@enduml

/TakeV/spacemacs/media/commit/055481a7951856edc06e09057b215daa6fc246ba/layers/+lang/plantuml/img/dia.png

Install

To use this contribution add it to your ~/.spacemacs

  (setq-default dotspacemacs-configuration-layers '(plantuml))

Key bindings

Key Binding Description
SPC m c c or C-c C-c Build diagram from the text in the current buffer
SPC m c o Set the output type (unicode text, svg, or png)