docute - 无需编译的文档生成器,使用 markdown 格式撰写

2016-12-10 22:17:55 +08:00
 sox

一般的文档网站会选择使用 gitbook 或者 hexo 之类的静态博客生成器构建,但它们都需要把 markdown 文件编译成静态的 html 文件, docute 可以省去这一步,因为它在你访问的时候才请求相关文档然后解析为 html 展现出来。

比如 github pages 支持从 ./docs 目录部署网站,那么在你访问首页的时候它就请求 ./README.md 然后渲染出来。这样你的 repo 里就不会有一堆编译生成的文件了。只需要 push 然后即刻生效。

docute 的文档就是由 docute 支持的: https://docute.js.org


灵感源自 docpress 和 https://www.v2ex.com/t/323516 cc @qingv

7134 次点击
所在节点    分享创造
7 条回复
airyland
2016-12-10 22:46:10 +08:00
貌似和 docsify 没什么不同?
qingv
2016-12-11 05:56:11 +08:00
支持
InFaNg
2016-12-11 18:38:55 +08:00
滋瓷
sox
2016-12-12 00:08:11 +08:00
@airyland UI 上有些不同,比如侧边栏 toc 的功能更接近 vuejs.org ,以及支持 front-matter 等等
airyland
2016-12-12 10:48:41 +08:00
@sox 侧栏的样式确定比较合理, docsify 的颜色有点太浅了。另外 8080 端口太常见了,建议换个默认端口,或者可以配置。
sox
2016-12-12 11:05:34 +08:00
@airyland 可以设置的 --port
visionsmile
2016-12-12 11:41:26 +08:00
great,已 star

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/326733

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX