MKDocs 使用

仅以此文介绍如何使用MKDocs,官网

1. 安装MKDocs

1. 安装Python
2. pip 安装
   $ pip install mkdocs
3. 检查是否安装成功
   $ mkdocs --version

2. 使用MKDocs

1. 创建工程
  $ mkdocs new my-project
  $ cd my-project
2. 开启本地服务器
  $ mkdocs serve
image.png
3. 在浏览器中打开默认页面 http://127.0.0.1:8000/

4. 新增一个页面
    可以自己手动写一个md文件放在docs目录下,并在配置文件中按照下面格式进行配置.
配置完会自动编译,若没有编译,则需手动编译
   $ mkdocs build
image.png
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,540评论 25 708
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    小迈克阅读 3,056评论 1 3
  • 11.26. 天气:晴 好早就买好了圣诞树 ,昨天终于最后装载完毕,简单的布置了家里,营造了一些节日的气氛。邀请了...
    亚茹_我是阿茹阅读 291评论 0 0
  • 有时,很喜欢依窗听雨,喜欢感受这夏雨带来的清凉。 有时,很喜欢在这个多情的雨季,撑一把油纸伞,漫步在江南的烟雨中,...
    岂无酒阅读 141评论 2 2
  • 来自意大利艺术家Francesco Camillo Giorgino的户外涂鸦。 【大课美术设计推荐词】:艺术产生...
    美术视觉阅读 406评论 0 1