Opensuse-docs/prep-meeting-11-20

期望的功能

1. GitHub 集成
2. 全文搜索
3. 宿主无关 / 低占用
4. FOSS

最有希望的

Sphinx（作为带有“Read the Docs”的服务）

• 重构文本，基于 Python 栈的 Markdown
• 许多主题，如 https://sphinx-themes.org/
• 良好声誉
• 不支持热重载

MkDocs

• 基于 Python 栈的 Markdown
• 支持热重载
• 对所需环境相当中立
• 超级简单易用
• 通过 Python Markdown 库支持所有口味的 Markdown
• 活跃的社区 / 易于支持

BookStack

• WSIWYG，基于 Laravel、PHP、MySQL 技术栈的 Markdown
• 超级干净
• 用户友好的前端
• 除了配置之外，学习曲线非常平缓

Antora + Adoc

• AsciiDoc，MkDocs 的 JS 等效项（用于 Asciidoctor 的 Node 驱动程序）
• 就格式和排版而言，AsciiDoc 技术栈被认为优于任何竞争对手
• Antora 技术栈相对较新 / 经过战斗的经验较少
• AsciiDoc 具有相当陡峭的学习曲线

后续的

Hugo & Docsy

• 纯 Go Web 框架
• 通过短代码将 Markdown 和类似 HTML 的语法很好地融合在一起
• 如果我们不需要构建完整的网站，可能有点过头
• 预计会有一些学习曲线，尤其是在使用带有“短代码”的 Markdown 时

Docusaurus

• Markdown，基于 Node 栈，前端使用 ReactJS
• 支持热重载
• 紧密的 GitHub 集成
• 糟糕的文档
• 如果我们不使用 ReactJS，则有点过头
• 预计会有一些学习曲线

en.opensuse.org

• 内部开发
• 不太美观

Gatsby

• 用于 JS 密集型网站
• 对未来的维护者来说，技术债务太重

VuePress

• 与 Gatsby 相同

Dauxio

• 主要用于 API

mdBook

• 缺乏功能

Doxgen

• 主要用于 API

GitHub Pages

• 锁定在 Github.com
• 通用网页生成器，并非特别针对文档

Gitbook.com

• 非 FOSS
• 非平台无关