1. 程式人生 > 其它 >線上文件生成工具 mkdocs 使用方法

線上文件生成工具 mkdocs 使用方法

簡介

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