1. MkDocs快速入门¶

MkDocs是一个快速、简单的静态站点生成器，面向构建项目文档。文档源文件以Markdown格式编写，并使用单个YAML配置文件进行配置。

1.1. 安装¶

使用Anaconda配置单独的Python环境（mkdocs为自定义环境名称）。

conda create -n "mkdocs" python=3

进入python环境（mkdocs为自定义环境名称）。

conda activate mkdocs

使用pip安装模块（mkdocs为python模块名称）。

pip install mkdocs

检查mkdocs版本信息。

mkdocs --version

创建项目目录（mkdocs为项目名称）。

mkdocs new mkdocs
cd mkdocs

启动内建服务器（服务器地址 http://127.0.0.1:8000/）。

mkdocs serve

项目配置文件为mkdocs.yml。

通过更改 site_name 值更改项目名称（Note为项目名称）。

site_name: Note

添加 nav 菜单添加页面（包含Home、MkDocs两个页面）。

nav:
- Home: 'index.md'
- MkDocs: 'mkdocs.md'

配置readthedocs风格主题。

theme: readthedocs

生成静态页面目录site。

mkdocs build

pip install python-markdown-math

extra_javascript:
    - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML

markdown_extensions:
    - mdx_math

$ ... $

$$ ... $$

当\(a \ne 0\)时，方程\(ax^2 + bx + c = 0\)有两个根：
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$