documentation / wiki

[cxumol]

目标

必需有:

• def list
• full text search

不能有:

• nodejs
  • node_modules

比较

全文搜索方案

• 纯前端
• 中端
• 后端

def list

从tzx扒

方便程度

jekyll

已经不在乎 gh-pages 自动构建了

sphinx

Mkdocs

其他选手

单页MD

• https://github.com/egojump/docup
• https://github.com/luyilin/kokk

结论

分三档,

全能
sphinx

平衡
Mkdocs

快捷
docsify

[cxumol]

挑选原则

• 稳定可靠, 装备不花一分钱
• 必须要有
  • 本地全文搜索, 支持中文
  • 页面间灵活跳转
• 不能沾
  • /*/node_modules/