plantuml-renderer
2
总安装量
2
周安装量
#64718
全站排名
安装命令
npx skills add https://github.com/cruldra/skills --skill plantuml-renderer
Agent 安装分布
cline
2
gemini-cli
2
github-copilot
2
codex
2
kimi-cli
2
cursor
2
Skill 文档
PlantUML Renderer
å°å å« PlantUML 代ç çè¾å ¥æ¸²æä¸ºå¾è¡¨æä»¶ï¼æ¯æææ¬è¾å ¥ä¸æä»¶è¾å ¥ã
使ç¨åºæ¯
- ç¨æ·æç¡®è¦æ±â渲æ PlantUML / çæ UML å¾ / å¯¼åº svg/png/txt/utxtâã
- ç¨æ·æä¾äºä»»æå
嫿æ PlantUML 代ç åï¼
@startuml ... @endumlï¼çå 容ã - è¾å
¥ä¸ä¸å®æ¯
.pumlï¼ä¹å¯ä»¥æ¯ MarkdownãWord ææ¡£æåææ¬çã
åææ¡ä»¶ï¼å¿ é¡»å æ£æ¥ï¼
- å¿
é¡»éªè¯ Java å¯ç¨ï¼
java -version - å¿
须确认 JAR åå¨ï¼
./assets/plantuml.jar - å¦æç¼ºå° Java æ JARï¼åæ¢æ¸²æå¹¶æç¡®åç¥ç¼ºå¤±é¡¹ã
æ å工使µ
-
æ¥æ¶è¾å ¥
- æ¯æä¸¤ç±»è¾å
¥ï¼
- ç¨æ·ç´æ¥ç²è´´çææ¬ã
- ç¨æ·æä¾çæä»¶è·¯å¾ã
- æ¯æä¸¤ç±»è¾å
¥ï¼
-
æå PlantUML 代ç
- ä»è¾å
¥ä¸æå宿´
@startuml ... @enduml代ç åã - è¥æ²¡æä»»ä½ææä»£ç åï¼è¿åæç¡®é误并æç¤ºç¨æ·è¡¥å ææ PlantUML 代ç ã
- ä»è¾å
¥ä¸æå宿´
-
确认è¾åºæ ¼å¼
- 询é®ç¨æ·è¾åºæ ¼å¼ï¼å¦
svgãpngãtxtãutxtï¼ã - ç¨æ·æªæå®æ¶ï¼é»è®¤ä½¿ç¨
svgã
- 询é®ç¨æ·è¾åºæ ¼å¼ï¼å¦
-
æé 渲æå½ä»¤
- å½ä»¤åæ°éåè
./references/cli_man.txtã - æ¨è使ç¨
--format <name>ï¼ä¹å¯ä½¿ç¨--svg/--png/--txt/--utxtã
- å½ä»¤åæ°éåè
-
æ§è¡æ¸²æå¹¶çææä»¶
- é»è®¤è¾åºå½åè§åï¼
- 妿è¾å
¥æ¯æä»¶ï¼
<input_filename>.<format> - 妿è¾å
¥æ¯ç²è´´ææ¬ï¼
output.<format>
- 妿è¾å
¥æ¯æä»¶ï¼
- è¥ä¸ä¸ªè¾å
¥ä¸æå¤ä¸ª
@startumlåï¼PlantUML å¯è½æ_001ã_002追å åç¼è¾åºï¼å±äºæ£å¸¸è¡ä¸ºã
- é»è®¤è¾åºå½åè§åï¼
-
ASCII ææ¬æ ¼å¼ç¹ä¾
- å½è¾åºæ ¼å¼æ¯
txtæutxtï¼çº¯ææ¬å¾ï¼æ¶ï¼å¿ é¡»åèï¼./references/ascii_guide.md
- è¾åºæ©å±åé常为
.atxtæ.utxtï¼åºå¨ç»æè¯´æä¸æç¡®å®é çææä»¶åã
- å½è¾åºæ ¼å¼æ¯
å½ä»¤æ¨¡æ¿
以ä¸å½ä»¤å以æè½ç®å½ä¸ºå½åå·¥ä½ç®å½ä¸ºåæã
æä»¶è¾å ¥
java -jar "./assets/plantuml.jar" --format svg "<input_file>"
java -jar "./assets/plantuml.jar" --format png "<input_file>"
java -jar "./assets/plantuml.jar" --format txt "<input_file>"
java -jar "./assets/plantuml.jar" --format utxt "<input_file>"
ææ¬è¾å ¥ï¼éè¿ stdinï¼
java -jar "./assets/plantuml.jar" --svg -pipe > "output.svg"
å¦é ASCIIï¼
java -jar "./assets/plantuml.jar" --txt -pipe > "output.atxt"
java -jar "./assets/plantuml.jar" --utxt -pipe > "output.utxt"
å ³é®è§å
- ä¼å ä¿è¯âæå代ç å + æ£ç¡®æ ¼å¼ + æåè½çâä¸ä»¶äºã
- ä¸è¦å设è¾å
¥æ¯å®æ´
.pumlæä»¶ï¼åªè¦ä»£ç åææå°±åºå¤çã - è¥å½ä»¤æ§è¡å¤±è´¥ï¼è¿ååå§é误并ç»åºå¯æä½ä¿®å¤å»ºè®®ï¼JavaãJAR è·¯å¾ãè¯æ³é误ãGraphviz ä¾èµçï¼ã
- å¯¹è¯æ³æ£æ¥å¯ä½¿ç¨ï¼
java -jar "./assets/plantuml.jar" --check-syntax "<input_file_or_dir>"
å¿«éæ£æ¥æ¸ å
-
java -versionæå -
./assets/plantuml.jaråå¨ - å·²æåè³å°ä¸ä¸ªææ
@startuml ... @enduml - 已确认è¾åºæ ¼å¼ï¼é»è®¤
svgï¼ - å·²æ§è¡æ¸²æå½ä»¤å¹¶ç¡®è®¤è¾åºæä»¶åå¨
- è¥ä¸º
txt/utxtï¼å·²åè./references/ascii_guide.md