> For the complete documentation index, see [llms.txt](https://huataihuang.gitbook.io/cloud-atlas-draft/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://huataihuang.gitbook.io/cloud-atlas-draft/develop/doc/mkdocs.md).

# MkDocs

[MkDocs](https://www.mkdocs.org)是一个快速，简单的静态网站生成工具，可以用来构建个人项目文档。语法采用Markdown，配置采用YAML。

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

最初我是从 [argo-cd官方文档](https://argoproj.github.io/argo-cd) 发现了这个文档平台，随后也发现一些著名开源项目采用了MkDocs:

* [Gluster官方文档](https://docs.gluster.org/en/latest/)

> 如果刚开始无从下手的话，可以先从 [glusterdocs](https://github.com/gluster/glusterdocs) 项目开始，把代码clone下来，然后按照自己的需求进行模仿改造。

感觉比较适合个人的知识库撰写。这也是我对[gitbook](https://github.com/huataihuang/cloud-atlas-draft/tree/6f3204fffc11cf006abd394631e2598d98b415c3/develop/doc/gitbook/README/README.md)编译缓慢不满，一直想替换掉gitbook的一个选择。