• 微信公众号:美女很有趣。 工作之余,放松一下,关注即送10G+美女照片!

在线文档生成工具 mkdocs 使用方法

开发技术 开发技术 4小时前 4次浏览

简介

mkdocs 是一款在线文档生成工具,可以生成比较漂亮的在线文档。比如我个人的C++笔记就是用它生成的:https://demon90s.github.io/CppStudy/

其实 mkdocs 功能就是把一堆 markdown 文档生成成一些 html 的静态页面。

mkdocs 的官网是:

https://www.mkdocs.org/

安装

官网安装参考:
https://www.mkdocs.org/user-guide/installation/

我测试安装的环境是 VirtualBox 中的 CentOS7 。关于如何在 VirtualBox 中安装 CentOS7 可以参考我这篇 BLOG :https://www.cnblogs.com/demon90s/p/6086350.html

安装步骤

$ yum install python36
$ wget ftp://lovemiemie.xyz/pub/install_package/ubuntu/get-pip.py
$ python3.6 get-pip.py
$ pip install mkdocs
$ mkdocs --version

创建一个 mkdocs 项目

$ mkdocs new my-project
$ cd my-project

启动服务

mkdocs serve -a 10.0.2.15:8001

PS: 10.0.2.15 是虚拟机的默认地址。

虚拟机做端口转发,关于端口转发也可以参考上面引用的博客。

打开浏览器即可访问 127.0.0.1:8001

创建静态页面

mkdocs build

程序员灯塔
转载请注明原文链接:在线文档生成工具 mkdocs 使用方法
喜欢 (0)