从markdown生成技术文档网站的工具

Tool to generate technical documentation website from markdown

我正在寻找一种工具来生成 static 网站来托管一些内部文档,例如开发技巧、我们使用的工具、一些简单的教程等。这个想法在团队中共享它,而不是非正式的。

我敢肯定那里有很多工具,要尝试选择一个实际上是一件让人不知所措的事情。 rmarkdown / blogdown 看起来很酷,但我以前从未听说过。 Github Markdown Render 看起来很有趣(但不是静态的),当然有数百种博客工具,还有很多从代码生成网站的工具(Sphinx、Doxygen)。

更具体的要求:

大家有什么推荐吗?

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

docsify可能会满足您的需求。

As simple as possible, ideally creating the website files in one command line.

一条命令创建了一个docsify站点。

docsify init ./docs

Possibility to navigate between files.

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

Well supported / big community.

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

Nice rendering, especially for code.

If possible, customizable for looks and a to give more control on layout.

它是可定制的。您可以在 Awesome Docsify.

上找到由 docsify 创建的网站和 docsify 的主题

General enough so that I can change tool if someday I decide I want finer control.

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

如果有人感兴趣,我开始使用 Hugohugo-geekdoc

  • 开箱即用
  • 设置/构建/部署真的很容易
  • 可随意定制(尽管我尽量不浪费太多时间)

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