文件布局 你的文档源码应该写成常规的 Markdown 文件 (参见下面的 Markdown 写作)，并放在文档目录中。默认情况下，这个目录将被命名为docs，并存在于项目的顶层，与mkdocs.yml配置文件一起。
您可以创建的最简单的项目看起来是这样的。
mkdocs.yml docs/ index.md 按照惯例，您的项目主页应该命名为index.md (详见下面的索引页)。以下任何一个文件扩展名都可以用于您的Markdown源文件：markdown, mdown, mkdn, mkd, md。所有包含在您的文档目录中的Markdown文件都会在建好的网站中呈现，而不考虑任何设置。
注
MkDocs 会忽略文件和目录名称以点开头的文件和目录（例如：.foo.md 或 .bar/baz.md），这与大多数 Web 服务器的行为一致。没有选项可以覆盖这种行为。
用Markdown写作 MkDocs页面必须用Markdown语言编写，这是一种轻量级的标记语言，它能产生易读、易写的纯文本文档，并能以可预见的方式转换为有效的HTML文档。
MkDocs使用Python-Markdown库将Markdown文档转换成HTML。Python-Markdown几乎与参考实现完全兼容，尽管有一些非常小的差异。
除了在所有Markdown实现中通用的基本Markdown语法外，MkDocs还包括支持用Python-Markdown扩展来扩展Markdown语法。请参阅MkDocs的markdown_extensions配置设置，了解如何启用扩展的细节。
MkDocs默认包含了一些扩展，下面高亮显示。
内部链接 MkDocs允许你通过使用常规的Markdown链接来相互链接你的文档。然而，为MkDocs格式化这些链接有一些额外的好处，如下所述。
链接到页面 当在文档中的页面之间进行链接时，您可以简单地使用常规的Markdown链接语法，包括您希望链接到的Markdown文档的相对路径。
请参阅项目许可证了解更多细节。 当 MkDocs 构建运行时，这些 Markdown 链接将自动转化为指向相应 HTML 页面的 HTML 超链接。
