从 Markdown 生成技术文档网站的工具答案

【问题标题】：Tool to generate technical documentation website from markdown从 Markdown 生成技术文档网站的工具
【发布时间】：2021-07-09 21:49:09
【问题描述】：

我正在寻找一种工具来生成静态网站以托管一些内部文档，例如开发技巧、我们使用的工具、一些简单的教程等。我的想法是在其中分享它团队，相当非正式。

我敢肯定，市面上有很多工具，但实际上很难选择其中一种。 rmarkdown / blogdown 看起来很酷，但我以前从未听说过。 Github Markdown Render 看起来很有趣（但不是静态的），当然有数百种博客工具，还有很多可以从代码生成网站的工具（Sphinx、Doxygen）。

更具体的要求：

尽可能简单，最好在一个命令行中创建网站文件。我们不需要完整的 WordPress 设置。
漂亮的渲染，尤其是代码。我喜欢用 Github 渲染 ex。
可以在文件之间导航。
得到很好的支持/大型社区。li>
如果可能的话，可自定义外观和对布局等进行更多控制。但不是优先事项。
足够通用，因此如果有一天我决定需要更好的控制，我可以更换工具。

你们有什么建议吗？

PS : 我选择 Markdown 是因为它似乎是最常见的，而且我已经知道/使用它，但我愿意休息或做任何事情。

【问题讨论】：

标签： r-markdown markdown documentation

【解决方案1】：

docsify 可能会满足您的需求。

尽可能简单，最好在一个命令行中创建网站文件。

一个 docsify 站点是在一个命令中创建的。

docsify init ./docs

可以在文件之间导航。

有一个侧边栏可以在文件之间导航。

得到很好的支持/大型社区。p>

这是一个 17.3k 的项目。现在有 160 位贡献者（2021 年 4 月 16 日）。

漂亮的渲染，尤其是代码。

如果可能，可自定义外观和 a 以更好地控制布局。

它是可定制的。您可以在 Awesome Docsify 上找到 docsify 创建的网站和 docsify 的主题。

足够通用，如果有一天我决定想要更好的控制，我可以更换工具。

别担心。许多工具都支持 Markdown。您可以随时更改工具。

【讨论】：

哇，它看起来真的很酷，谢谢！但是，我宁愿拥有一个静态网站，因为它更便携，而且我可以在本地访问文档而无需运行服务器。不过我会看看。
您可以通过docsify serve docs在本地运行网站。请阅读手册以获取更多信息。
是的，我已经看到了，但它并不完全是一个静态服务器，实际上它似乎是故意动态生成 HTML 的，这不是我想要的。跨度>
我认为 blogdown 会更好，但我不需要所有 R 嵌入的东西

【解决方案2】：

如果有人感兴趣，我会使用 Hugo 和 hugo-geekdoc

开箱即用看起来很棒
非常容易设置/构建/部署
随意定制（虽然我尽量不浪费太多时间这样做）

显然这是个人选择，@cyrus 提到的 docsify 甚至 github wiki 等其他解决方案也可以适用。

【讨论】：