plantuml-previewer.vim - GitLite

KO | EN

gitlite — search

#ai #typescript #llm #rust #deep-learning #macos #nodejs #cli #kubernetes #vue #awesome-list #mcp #ios #open-source

plantuml-previewer.vim

(★ 275)

Vim / Neovim plugin for preview PlantUML

파일 탐색기

최종 버전 다운로드 (.zip)

- - _plantuml_previewer.vim
  - plantuml_previewer.vim
  - plantuml_previewer.vital
- plantuml_previewer.vim
- plantuml-previewer.txt
- plantuml.jar
- plantuml-previewer.vim
- save-as.cmd
- save-as.sh
- update-viewer.cmd
- update-viewer.sh
- - c027ca96553d780c4370107827292565.svg
  - c38c5e8361a61039ba107d5798346ce6.svg
  - ce21159a71b4ecaf63de7f048eef373b.svg
  - index.html
  - main.3f72aac9.css
  - main.e8e44d5b.js
  - vendors~main.16025f89.js
- - index.js
  - index.scss
  - preview.vue
- index.ejs
- index.html
- package-lock.json
- package.json
- poi.config.js
.gitignore
demo.puml
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/weirongxu/plantuml-previewer.vim

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd plantuml-previewer.vim

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

cd viewer

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Plantuml Previewer Vim

Vim/NeoVim plugin for preview [PlantUML](http://plantuml.com/)

![image](https://user-images.githubusercontent.com/1709861/40650003-dcd75a76-6364-11e8-8cb1-40d710a0cc0a.png)

## Dependencies

- Java
- Graphviz (https://www.graphviz.org/download/)
  - brew install graphviz
  - apt-get install graphviz
- [open-browser.vim](https://github.com/tyru/open-browser.vim)
- [aklt/plantuml-syntax](https://github.com/aklt/plantuml-syntax) (vim syntax file for plantuml)

## Usage

1. Start editing plantuml file in Vim
2. Run `:PlantumlOpen` to open previewer webpage in browser
3. Saving plantuml file in Vim, then previewer webpage will refresh

### Commands

#### PlantumlOpen

Open previewer webpage in browser, and watch current buffer

#### PlantumlStart

Like `PlantumlOpen`, but won't open in browser

#### PlantumlStop

Stop watch buffer

#### PlantumlSave [filepath] [format]

Export uml diagram to file path  
Available formats

> png, svg, eps, pdf, vdx, xmi,
> scxml, html, txt, utxt, latex

Example:

```
:e diagram.puml

:PlantumlSave
:PlantumlSave diagram.png
:PlantumlSave diagram.svg
```

### Variables

#### `g:plantuml_previewer#plantuml_jar_path`

Custom plantuml.jar file path

If plant uml was installed by homebrew, you can add the following code to your `.vimrc` to use the version installed by homebrew:

```vim
au FileType plantuml let g:plantuml_previewer#plantuml_jar_path = get(
    \  matchlist(system('cat `which plantuml` | grep plantuml.jar'), '\v.*\s[''"]?(\S+plantuml\.jar).*'),
    \  1,
    \  0
    \)
```

#### `g:plantuml_previewer#file_pattern`

Files that will be watched by plugin.

Default: `*.pu,*.uml,*.plantuml,*.puml,*.iuml`

If you want add another files, place something like this to your `.vimrc`:

```vim
let g:plantuml_previewer#file_pattern = "*.pu,*.uml,*.plantuml,*.puml,*.iuml,*.md"
```

#### `g:plantuml_previewer#save_format`

`:PlantumlSave` default format  
Default: 'png'

#### `g:plantuml_previewer#viewer_path`

Custom plantuml viewer path  
The plugin will copy viewer to here if the directory does not exist  
And `tmp.puml` and `tmp.svg` will output to here

#### `g:plantuml_previewer#debug_mode`

Debug mode  
The plugin will print debug message if this is set to `1`  
Default: 0

## Related

- [vim-slumlord](https://github.com/scrooloose/vim-slumlord)
- [previm](https://github.com/kannokanno/previm)