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 config 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] browser 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/
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 [email protected] 举报，一经查实，本站将立刻删除。