# 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的一个选择。


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://huataihuang.gitbook.io/cloud-atlas-draft/develop/doc/mkdocs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.