mkdocs 入门mkdocs快速入门教程 MkDocs是一个快速、简单、华丽的静态网站生成器，适用于构建项目文档。文档

MkDocs是一个快速、简单、华丽的静态网站生成器，适用于构建项目文档。文档源文件以Markdown编写，并使用一个YAML文件来进行配置。 MkDocs生成完全静态的HTML网站，你可以将其部署到GitHub pages、Amzzon S3或你自己选择的其它任意地方。

官方地址：www.mkdocs.org/
中文文档地址：mkdocs.zimoapps.com/

MkDocs有一堆很好看的主题。官方内置了两个主题： mkdocs 和readthedocs，也可以从MkDocs wiki中选择第三方主题，或者自定义主题。

安装 Mkdocs

Mkdocs是用Python开发的工具可以使用pip命令来安装

[![alt text](http://path/to/img.jpg "title")](你的链接地址)

pip install mkdocs

使用

使用很简单直接在命令行

mkdocs new my-project

这样就会在本地建立一个my-project文件夹　其中包括了一个mkdocs.yml和一个docs文件夹

mkdocs.yml: 这个文件是一个配置文件主要配置你的站点名字，板块等具体配置点我
docs: 是存放你要写的 Markdown 文档的地方初始化一个index.md文档配置点我。

在本地查看搭建的文档效果

$ mkdocs serve
Running at: http://127.0.0.1:8000/

然后访问http://127.0.0.1:8000/就可以看到生成文档的效果了

使用mkdocs 教程参考：

mkdocs 教程：shafish.cn/blog/mkdocs…

mkdocs-material： Customization - Material for MkDocs (squidfunk.github.io)

mkdown 图标库

图片加链接写法
[![alt text]( http://path/to/img.jpg "title")](你的链接地址)

markdown_extensions:
  - markdown.extensions.attr_list
  - md_in_html # 图片
  - pymdownx.highlight # 高亮
  - attr_list # 按钮
  - pymdownx.inlinehilite # 行内高亮
  - pymdownx.snippets
  # 提示，警告栏
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  # 内容标签
  - pymdownx.tabbed:
      alternate_style: true
  - tables # 表格
  - footnotes # 注脚
  # 图标
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg