mkdocs 和 mardown文档

mardown是编辑器语言，mkdocs是文档工具、mkdocs文档的编写语言是mardown

需要Python 和 Python package manager 来安装 MkDocs . 可以通过以下命令查看是否安装了上述依赖:

$ python --version
$ pip --version

安装MkDocs

使用 pip 安装 mkdocs :

$ pip install mkdocs

mkdocs已经安装到你的系统. 运行 mkdocs help 以检查是否正确安装.

$ mkdocs help

创建项目

$ mkdocs new my-project
$ cd my-project

有一个配置文件 mkdocs.yml, 和一个包含文档源码的 docs 文件夹. 在 docs 文件夹里包含了一个名为 index.md 的文档.

MkDocs 包含了一个内建的服务器以预览当前文档. 控制台切换当前目录到 mkdocs.yml 配置文件相同文件夹,

输入 mkdocs serve 命令以启动内建服务器:

$ mkdocs serve

在浏览器中打开 http://127.0.0.1:8000/ , 你将看到页面:

站点生成

我们现在已经可以发布 MkLorum 文档了. 通过以下命令生成文档.

$ mkdocs build

mardown的基础语法：

标签：H1 H2 H3.....
# Headline 1
## Headline 2
### Headline 3


标签：P、B 回车换行就是P，双下划线和双星号都是加粗
Usetwoasterisksfor strongemphasis.
Or,ifyouprefer,__usetwoundetead__ is  **abc**

引用
>ThismoduleimplementsanumberofiteratorbuildingblocksinspiredbyconstructsfromAPL,
Haskell,andSML.EachhasbeenrecastinaformsuitableforPython.


各种列表
* Apple
* Orange
+ Peach
+ Banana
- Peach
- Banana

嵌套列表
1. Fruit　　
    * Apple　　
    * Orange　　
    * Peach　　
    * Banana
2. Vegetable　　
    + Potato　　
    + Cabbage

标签：A 和 img
This is an [example link](http://example.com/).

代码块
三个` 开始   三个`结束