mkdocs 介绍
MkDocs 是 一个 用于创建项目文档的? 快速 ,? 简单 ?,? 完美华丽 ?的静态 站点 生成 器. 文档源码使用 Markdown 来撰写,用 一个 YAML 文件 作为配置文档.??
任意托管.构建完全的静态 html 站点 ,可以将它托管到 GitHub pages,Amazon S3 等任意地方.
大量 主题 .默 认包含大量美观的 主题 . 可以从 bootstrap,readthedocs 和 12 款 bootswatch 主题 中选择.
即时预览.内建的开发服务器使你在撰写文档的时候就即时预览. 它甚至能在保存更改时 自动 载入,只需刷新浏览器就可以查看更改.
易于配置.可以配置文档 主题 .
交叉索引.使用 MkDocs 链接 语法创建交叉索引.
安装
pip install mkdocs
使用
λ mkdocs.exe new mydoc
INFO - Creating project directory: mydoc
INFO - Writing con fig file: mydocmkdocs.yml
INFO - Writing initial docs: mydocdocsindex.md
λ cd mydoc
d:codemydoc
λ ls
docs/ mkdocs.yml
d:codemydoc
λ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
[I 190528 20:32:49 server:296] Serving on http://127.0.0.1:8000
[I 190528 20:32:49 handlers:62] Start watching changes
[I 190528 20:32:49 handlers:64] Start detecting changes
[I 190528 20:33:06 handlers:135] bro wser Connected: http://127.0.0.1:8000/
网站地址 : https://markdown-docs-zh.readthedocs.io/zh_CN/latest/
GitHub: https://github.com/mkdocs/mkdocs
网站描述: Python 一个 对 Markdown 非常友好的文档 生成 器
mkdocs官方网站
官方网站： https://markdown-docs-zh.readthedocs.io/zh_CN/latest/
如果觉得 网站内容还不错，欢迎将 网站 推荐给程序员好友。