MkDocs

MkDocs是一个快速,简单的静态网站生成工具,可以用来构建个人项目文档。语法采用Markdown,配置采用YAML。

文档可以托管到GitHub pages, Amazon S3或者自建服务器。

最初我是从 argo-cd官方文档 发现了这个文档平台,随后也发现一些著名开源项目采用了MkDocs:

如果刚开始无从下手的话,可以先从 glusterdocs 项目开始,把代码clone下来,然后按照自己的需求进行模仿改造。

感觉比较适合个人的知识库撰写。这也是我对gitbook编译缓慢不满,一直想替换掉gitbook的一个选择。

Last updated