←↑→↓↖↙↗↘↕⏤
unicode=Geometric Shapes
▶ 仅仅个别字不同的时候的对比标识
◆
◉ 着重强调
◆ 1、
◆ 2、
◆ 3、
Miscellaneous Symbols
☞
Dingbats
✍ 重点记忆，个人总结的点，或者知识。
✎✎
⟱
| 章节号 | 内容 |
|---|---|
| 1图片格式(png) | 宽度大于620px,保持高宽比减低为620px |
| 1-1 | 应用 |
| 1-1-1 | 方法 |
仔细回顾思索，其实我们能够发现，在人生这个不断的学习充电的过程中，记录学习的过程是十分重要的，不但是学习当下的补充和巩固，同时也是将来回忆重温的必要基础。
-
1 安装mkdocs（基于Python）
没有安装python必须要首先安装python环境。
MkDocs 支持 Python versions 3.5, 3.6, 3.7, 3.8, and pypy3.
某些情况下，因为python安装包不太新的关系，会造成pip工具版本过低，影响安装mkdocs，所以有必要先更新一下pip。
pip install --upgrade pip
⟱ 然后安装mkdocs。使用国内源安装会比较快一些。
国内源安装的格式：pip install -i 国内源网址 包名
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple mkdocs
下面是一些国内源
清华：https://pypi.tuna.tsinghua.edu.cn/simple
阿里云：http://mirrors.aliyun.com/pypi/simple/
中国科技大学 https://pypi.mirrors.ustc.edu.cn/simple/
华中理工大学：http://pypi.hustunique.com/
山东理工大学：http://pypi.sdutlinux.org/
⟱ 安装完毕，查看一下mkdocs的版本
mkdocs --version
⟱ 官方文档中，提及了一个工具click-man，实验安装
查看内容，其实就是生成了mkdocs的帮助文档。里面有mkdocs的使用。这里就是Linux下的帮助文档的格式。
-
2 起步
◆ 1、新建工程。做准备工作如下：
然后，输入以下命令：
mkdocs new my-project
cd my-project
此时会在文件夹下，产生一个mkdocs.yml文件和docs文件夹。其中：
mkdocs.yml是一个配置文件。
docs文件夹下保存你的文档的源文件。此时下面只有一个名为index.md的文件。
◆ 2、预览工程。
MkDocs带有内置的开发服务器，可让您在处理文档时预览文档。首先，先保证当前路径和mkdocs.yml在同一路径下。
然后输入命令：
mkdocs serve
此时将看到默认的主页显示。
注意：dev-server支持自动装载，只要工程目录下的配置文件、文档源文件或者是 theme目录发生改变，dev-server就会刷新整个工程，并实时显示修改结果。
这里修改了配置文件，dev-server就会自动刷新，并实时显示。
-
3 添加文档页面
文档的范例是使用curl命令。
curl 'https://jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md
具体分析分析，上述命令应该是在docs的文件夹下，产生一个about.md文件。那么我们手动添加一下试试。首先我们查看一下上述文档的内容是什么：
然后，复制一下index，改名为about。把上述文件的内容复制到about文件中。
◆ 在配置文件中添加导航信息
代码为：
site_name: Lil
nav:
- Home: index.md
- About: about.md
-
4 文档主题设置
将mkdocs.yml配置文件修改为：
site_name: Lil
nav:
- Home: index.md
- About: about.md
theme: readthedocs
-
5 修改 the Favicon Icon
在docs文件夹下，新建一个img文件夹
然后在文件夹中，放入自定义的图标文件，名为favicon.ico
要注意的是，这个修改，要Building之后才能看到效果。
-
6 编译文档 Building the site
编辑完毕后，开始编译文档.首先，进入mkdocs.yml路径下，使用命令：
mkdocs build