Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Latest commit

 

History

History
124 lines (82 loc) · 2.85 KB

README.md

File metadata and controls

124 lines (82 loc) · 2.85 KB
Raw

Notice

I stronglly recommend to use below plugin. I don't intend to update this plugin.

PlantUML

okazuki PlantUML

Visual Studio Code PlantUML plugin.

PlantUML is here.

Features

-PlantUML image previewer.

Preview window

Commands

  • PlantUML Preview : Start PlantUML preview.
  • PlantUML Export ***(*** is format type) : Export png, svg, eps, etc... to same directory.

Extension Settings

You must set the following environment variables for the extension to work:

  • JAVA_HOME: Java SDK installed directory (must have a bin sub-directory)
  • Windows example: C:\Program Files\Java\jdk1.8.0_101)
  • macOS example: /Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home
  • PLANTUML_JAR: Path for the plantuml.jar file
  • Windows example: C:\Users\UserName\bin\plantuml\plantuml.jar
  • macOS example: /usr/local/Cellar/plantuml/8048/libexec/plantuml.jar

If you want to use PlantUML's functionality that requires GraphViz, you need to set the GRAPHVIZ_DOT environment variable, as explained here:

  • GRAPHVIZ_DOT: Path for the dot executable binary
  • Windows example: C:\Program Files\Graphviz\bin\dot.exe
  • macOS example: /usr/local/Cellar/graphviz/2.38.0_1/bin/dot

After setting these environment variables you need to restart VSCode for the extension to work.

Known Issues

  • Execute preview process all text file.

Release Notes

0.2.2

  • Support plantuml file type. #24

0.2.0

0.1.9

  • Improvement scroll.
  • Support restructuredtext.

0.1.8

  • Fix typo

0.1.7

  • Bug fix.

0.1.5

  • Change setting method. PLANTUML_HOME -> PLANTUML_JAR

0.1.4

  • Revert encoding setting method.
  • Not lost focus when shown preview window.

0.1.3

  • Change encoding setting method. Change -chaset to -Dfile.encoding.

0.1.2

  • Refactor

0.1.1

  • Change uml background color to white.

0.1.0

  • Refactor
  • Support many export format.
  • No use TEMP env value.

0.0.13

  • Support relative path include.

0.0.12

  • Bugfix: Crush when init process(too...).

0.0.11

  • Bugfix: Crush when init process.

0.0.10

  • Correspondence to unsaved file.

0.0.9

  • Realtime preview.

0.0.8

  • Remove .exe extensions from java command. Maybe support Mac & Linux.

0.0.7

  • More error message improvement.

0.0.6

  • Error message improvement.

0.0.5

  • Update preview window when changed active editor.

0.0.4

  • Export png image.

0.0.3

  • Hide PlantUML window.
  • Support filename extension other than '.txt'

0.0.2

  • Set encoding utf-8

0.0.1

  • First release.