可视化你的 wiki

借助本地交互式节点图和阅读器浏览 OpenWiki Markdown wiki

为了浏览 OpenWiki Markdown wiki，openwiki visualize 会在你的浏览器中提供一个本地交互式节点图，旁边是实时 Markdown 阅读器。你也可以把同一个图与阅读器导出为静态目录以便托管。

打开可视化工具

在已经拥有 openwiki/ 目录的仓库中：

openwiki visualize

这会在 127.0.0.1:4321 上提供 ./openwiki，并在浏览器中打开该图。服务器运行期间，对 wiki 文件的编辑会被自动拾取。图面板位于 Markdown 阅读器旁边，可调整大小、可折叠。

选项

openwiki visualize openwiki --port 4400 --no-open

参数 / 标志	说明
[path]	要提供的 wiki 目录。默认为 ./openwiki
--port <port>	首选端口。默认为 4321。如果该端口已被占用则递增
--no-open	不自动打开浏览器
--export <dir>	写入一个静态可视化工具目录，而不是启动本地服务器。不能与 --port 或 --no-open 组合使用

要浏览个人 wiki：

openwiki visualize ~/.openwiki/wiki

可视化工具会显示：

• 由 wiki 概念及其之间的 Markdown 链接构成的交互式节点图
• 针对所选页面的并排实时 Markdown 阅读器

该图不会显示 INSTRUCTIONS.md 和其他脚手架文件。

导出静态站点

要将可视化工具与生成的文档一起发布，请导出静态目录，而不是启动服务器：

openwiki visualize <PATH> --export docs/openwiki-visualizer

导出的内容包含 index.html、client.js、client-lib.js、styles.css 和 graph.json。其客户端会读取同级的图文件，并且不使用实时重载，因此该目录可以由 GitHub Pages、MkDocs 或任何其他静态托管服务托管。

NOTE

该页面从公共 CDN 加载其图、Markdown 和图表库，因此本地查看器和静态查看器都需要联网。

另请参阅

• 快速入门
• 代码模式
• CLI 参考

---