利用mkdocs建立簡單的文檔博客
一、概述
MkDocs 是一個用於創建項目文檔的 快速, 簡單 , 完美華麗 的靜態站點生成器. 文檔源碼使用 Markdown 來撰寫, 用一個 YAML 文件作為配置文檔.
二、mkdocs安裝
1、安裝python
可以去python官網下載安裝,安裝方法網上很多就不多做贅述。
2、安裝mkdocs
python3安裝后已經自帶pip,可以立即安裝mkdocs。
pip install mkdocs
如果下載慢,可更換安裝源為豆瓣
pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-material
pip后因為生成的exe是在python下的,就可以使用cmd,如果不能使用,增加環境變量即可。
三、建立項目
1、初始化項目
mkdocs new my-project
2、修改主題
mkdocs.yml里添加:
theme:
name: material
3、生成html
mkdocs gh-deploy
# 生成在site目錄下,可以用瀏覽器查看效果
4、執行服務預覽效果
mkdocs serve
#通過瀏覽器打開 http://127.0.0.1:8000/ 查看效果
四、部署到gitee
因為沒做過自服務器部署就沒寫這部分,這里是部署在國內的gitee上。
1、新建倉庫
注冊、登陸碼雲,新建倉庫
2、windows下Git BASH安裝
git下載
http://www.git-scm.com/download/
教程
https://blog.csdn.net/weixin_41714277/article/details/79399270
3、Git BASH上傳
①右鍵打開Git BASH
②復制連接
③下拉倉庫
git clone 復制的連接
④將mkdocs生成的項目my-project移到倉庫文件夾內
⑤上傳
git add .
# 加入到暫存區
git commit -m up
# 提交到版本庫
git push
# 上傳