hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity
intellij-sdk-code-samples/buildUML
History
Jakub Chrzanowski 4e802980f2
Webhelp migration (#347) 
* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26

* [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles

* [webhelp] Fixes for Part #5 TXP00017

* [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin".

* [webhelp] Removed numbers from page section titles in rest of project *.md files.

* [new webhelp] Build #44 changes

* [new webhelp] Maintenance merge from master

* [new webhelp] Add placeholder file for webhelp import.

* [webhelp] Correct redirects for file name changes

* [webhelp] TOC not needed in webhelp

* [format] {:toc} not needed for webhelp

* add {:disable-links} to ensure demo links are not interpreted as real links.

* Put all badges on the same line to simplify composition.

* formatter.md: fix upsource link

* fix some links

* api_changes_list.md: remove note

* migrate to webhelp - initial

* fix GH edit URL

* remove sdkdocs-template setup in VCS config

* remove recently_updated.md

* restore COC/CONTRIBUTING.md

* api_changes_list.md: remove note

* useful_links.md: IPE

Co-authored-by: JohnHake <john.hake@jetbrains.com>
Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
2021-01-14 16:07:39 +01:00
..
messaging
Webhelp migration (#347)
2021-01-14 16:07:39 +01:00
jb-plantuml-theme.puml
[messaging infrastructure] convert uml diagrams
2020-05-27 17:36:38 -07:00
README.md
Docs maintenance (#316)
2020-09-21 17:15:08 +02:00

README.md

Working with PlantUML

These are temporary instructions, pending a move of more diagrams and utilities from the IntelliJ Platform codebase.

  • If you are unfamiliar with PlantUML, review the quick start instructions.
  • Install Graphviz on your machine.
  • Get and install the PlantUML Integration plugin for IntelliJ IDEA:
    • Set the GRAPHVIZ_DOT system or environment property to point to the directory containing the Graphviz executable on your machine. For example, export GRAPHVIZ_DOT="/usr/local/Cellar/graphviz/2.42.3/bin/dot"
    • In the PlantUML plugin Settings (Preferences/Settings | Other Settings | PlantUML) set:
      • The "Additional 'plantuml.include.path'" to be the absolute path to the directory containing the jb-plantuml-theme.puml file on your machine. For example, /<path to sdk root>/buildUML or, if you have the IntelliJ-Community source code, /<path to intellij-community root>/platform/docs/.
      • The "PlantUML config" to !include jb-plantuml-theme.puml

When a *.puml file is open in the IDE editor, the PlantUML Integration plugin will show a preview. To save a diagram in SVG format, change the file extension from the default PNG to SVG when saving the diagram from the preview window.