在前端开发中,我们常常需要用到文档生成工具。而在文档生成中,排版是一个很重要的部分。而 gitbook-plugin-dot 就是一款能够帮助我们排版的 npm 包。
了解 gitbook-plugin-dot
gitbook-plugin-dot 是一个 dot 渲染器插件。它能够将 dot 描述文件渲染成 svg、png、pdf 等格式的图像,使图像能够作为 GitBook 中的一部分来进行展示。
该插件使用 Graphviz 库,所以在使用之前,需要先确保 Graphviz 已经安装在本机中。
使用教程
安装 gitbook-plugin-dot:
$ npm install gitbook-plugin-dot --save-dev
将该插件添加到 book.json
文件中:
{ "plugins": ["dot"] }
在 Markdown 中,在一对``````之间输入内容,可以得到一个使用 dot 渲染器渲染的图像。
例如,要渲染一个简单的图:
```dot digraph G{ a -> b b -> c c -> d d -> e }
-- -------------------- ---- ------- -- ------- ----- ---------------------- -- ---- --------------- ----- ------ ------- - - ---- ---------------------- ---- ---------------------- - -- - -- -- - -- - -- -- - -- - -- -- - -- -- -
-- -------------------- ---- ------- ------- ---------------------------------------------------------------------------------------------------------------- -- -- ------------------ -------------------------------------------------------------------------------------------- - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------