(记录)配置使用gitbook的plantuml插件

文章目錄

1. 1. 使用步骤
   1. 1.1. 准备工作
   2. 1.2. 使用插件
2. 2. 参考资料

终于可以在gitbook里面直接使用plantuml了, 真心方便!

使用步骤

准备工作

1. 安装gitbook-plugin-plantuml

   修改package.json文件,增加一个gitbook-plugin-plantuml插件.

   “gitbook-plugin-plantuml”: “~0.0.15”

   "devDependencies": {
       ......
       "gitbook-plugin-plantuml":  "~0.0.15"
   },
   

   然后执行命令:

   npm install .

   也可以一次性执行命令:

   npm install gitbook-plugin-plantuml –save

2. 设置book.json

   在book.json中增加plugins设置:

   {
       "plugins": ["plantuml"],
   }
   

3. 下载plantuml.jar

   从官网download页面下载到plantuml.jar文件, 放到项目根目录下

4. 创建目录/assets/images/uml

使用插件

在需要插入planttuml图片的地方, 插入plantuml内容 (注意要放在类型为uml的代码块中):

@startuml
a -> b
@enduml

之后执行gitbook server或者grunt test命令, 生成gitbook的html内容时, 这里的plantuml内容就会被转换为uml图片,然后替换对应的plantuml文本内容.

这样我们就可以在文章内容中直接书写plantuml内容, 然后自动得到对应的图片, 非常方便.

参考资料

• gitbook-plantuml在github上的项目
• lyhcode贡献的代码和项目
• GitBook + PlantUML 以 Markdown 快速製作 UML 教材: lyhcode编写的使用文档