Mkdocs安装——搭建自己的文档库

安装

  • 安装pythonpip
$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2
  • 安装mkdocs
pip install mkdocs

创建项目

mkdocs new my-project
cd my-project

服务端启动

mkdocs serve
INFO    -  Building documentation... 
INFO    -  Cleaning site directory 
INFO    -  Template skipped: 'search.html'. Not found in template directories. 
[I 171030 18:49:19 server:283] Serving on http://127.0.0.1:8000
[I 171030 18:49:19 handlers:60] Start watching changes
[I 171030 18:49:19 handlers:62] Start detecting changes
^C[I 171030 18:50:41 server:303] Shutting down...

构建

mkdocs build

常用命令

  • mkdocs new [dir-name] - 创建项目
  • mkdocs serve - 启动http服务
  • mkdocs build - 构建HTML文件
  • mkdocs help - 帮助

配置mkdocs.yml

site_name: My Docs
theme: readthedocs

扩展阅读

当前位置:叶子坑 » Mkdocs安装——搭建自己的文档库

赞 (1)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址