Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,27 @@ will be forcefully inserted/updated at the top of your file!

Note: I have only used this for sequence diagrams - the ASCII output of
plantuml seems to be less than stellar for other diagram types.

Advanced usage
==============

* Separate window
* Swap the layout to vertical with `Ctrl+w H` or type `:wincmd H`

TIP: if the file extension was not recognized by default use `:set ft=plantuml` to enable the plugin.

```vim
" default path for the plantuml debian package
let g:slumlord_plantuml_jar_path = "/usr/share/plantuml/plantuml.jar"

" some common configurations
let g:slumlord_plantuml_include_path = "~/.config/plantuml/include/"

" use another buffer for preview
let g:slumlord_separate_win = 1

" enable utf symbols (default)
let g:slumlord_asciiart_utf = 1
```

![Demo alt](https://github.com/geraldolsribeiro/vim-slumlord/raw/master/_assets/demo-alt.gif)
Binary file added _assets/demo-alt.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.