gitlab胁出、github型型、gitee布署mkdocs主題倉庫
原址 ? 布署mkdocs ? calligraphy
1、概述
mkdocs作用
在git平臺創(chuàng)建mkdocs主題倉庫全蝶，自動將markdown文件生成靜態(tài)網(wǎng)頁闹蒜。
官網(wǎng) https://www.mkdocs.org/
簡介&主題 http://www.reibang.com/p/c005c45abe85
gitlab-mkdocs https://gitlab.com/pages/mkdocs
github-mkdocs-theme https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
python安裝及下載 https://gitlab.com/xuyq123/mynotes/-/blob/master/Python.md
mkdocs安裝 pip install mkdocs
2、gitlab布署mkdocs
gitlab mkdocs主題倉庫 （推送文件自動布署）
創(chuàng)建方法：
創(chuàng)建 mkdocs.yml裸诽、.gitlab-ci.yml文件嫂用。創(chuàng)建docs目錄，markdown文件放在此處丈冬。推送到倉庫嘱函。
可fork此倉庫 https://gitlab.com/xuyq123/plain-mkdocs https://xuyq123.gitlab.io/plain-mkdocs
注意：若部署失敗，可在 CI/CD --> Jobs查看原因埂蕊，修改 .gitlab-ci.yml 文件往弓。
本地調(diào)試：
安裝 python 及 mkdocs
相關命令
pip install mkdocs 安裝mkdocs
python -m pip install --upgrade pip 更新Python
mkdocs new my-project
mkdocs serve
mkdocs build
參考：
https://cloud.tencent.com/developer/article/1662592
https://blog.csdn.net/qq_32332433/article/details/106148965
------
主題安裝
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple mkdocs-Bootswatch 安裝多個主題
pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-material 安裝material主題
pip install --trusted-host pypi.douban.com -i http://pypi.douban.com/simple/ mkdocs mkdocs-gitbook 安裝gitbook主題
pip install mkdocs-cluster
pip install mkdocs-cinder
pip install mkdocs-bootstrap4
主題種類
The available installed themes are: readthedocs, cluster, lumen, flatly, yeti, material, cosmo, litera, sandstone, darkly, lux, minty, superhero,
gitbook, spacelab, cinder, pulse, mkdocs, cerulean, bootstrap, solar, journal, simplex, slate, materia, bootstrap4, ivory, cyborg, united
主題總結(jié)
mkdocs 默認主題，速度極快蓄氧。菜單橫向函似。藍邊白底。不夠美觀喉童。 評級四星撇寞。
material 速度一般。菜單豎向堂氯，左側(cè)整體文件結(jié)構(gòu)蔑担，右側(cè)文件目錄。紫邊白底咽白。 評級四星啤握。
readthedocs 速度一般。菜單豎向晶框。展示markdown文件目錄結(jié)構(gòu)排抬。黑邊白底。 評級四星授段。
sandstone 加載挺快蹲蒲。菜單橫向。黑邊白底侵贵。 評級四星届搁。
litera 加載挺快。菜單橫向。天藍邊白底咖祭。 評級四星。
lumen 加載挺快蔫骂。菜單橫向么翰。海藍邊白底。 評級四星辽旋。
spacelab 加載挺快浩嫌。菜單橫向。深藍邊白底补胚。 評級四星码耐。
cluster 加載挺快。菜單橫向溶其∩龋灰邊白底。 評級四星瓶逃。
slate 加載挺快束铭。菜單橫向。黑邊黑底厢绝。 評級四星契沫。
simplex 加載挺快。菜單橫向昔汉。深紅邊白底懈万。 評級四星。
united 加載挺快靶病。菜單橫向会通。橙紅邊白底。 評級四星嫡秕。
cinder 速度一般渴语，不顯示文件夾中的下拉文檔。展示markdown文件目錄結(jié)構(gòu)昆咽。菜單橫向驾凶。黑邊白底。適合單級目錄文件掷酗。 評級三星调违。
bootstrap4 速度相當慢。菜單橫向泻轰。黑邊白底技肩。 評級二星。
gitbook 速度一般。菜單豎向虚婿，灰邊白底旋奢。有版權(quán)廣告去不掉。 評級二星然痊。
ivory 速度相當慢至朗。菜單豎向，黑邊白底剧浸。 評級二星锹引。
3、github布署mkdocs
github mkdocs主題倉庫 （mkdocs gh-deploy 一鍵布署）
創(chuàng)建方法：
1唆香、創(chuàng)建 mkdocs.yml嫌变、README.md、.gitignore文件躬它。創(chuàng)建docs目錄腾啥，markdown文件放在此處。
2冯吓、本地調(diào)試 mkdocs serve 訪問：http://127.0.0.1:8000/ 碑宴。 推送上述三個文件。
3桑谍、一鍵布署 mkdocs gh-deploy （自動生成 gh-pages分支延柠，發(fā)布GithubPages ）
可fork此倉庫 https://github.com/scott180/plain-mkdocs https://scott180.github.io/plain-mkdocs/
本地調(diào)試：
安裝 python 及 mkdocs
相關命令
mkdocs serve
mkdocs gh-deploy
參考：
https://www.cnblogs.com/paulwhw/p/12725523.html
4、gitee布署mkdocs
gitee mkdocs主題倉庫 （GiteePages服務布署目錄）
創(chuàng)建方法：
1锣披、創(chuàng)建 mkdocs.yml贞间。創(chuàng)建docs目錄，markdown文件放在此處雹仿。
2增热、本地調(diào)試 mkdocs serve 訪問：http://127.0.0.1:8000/ 。
3胧辽、mkdocs build 生成靜態(tài)文件峻仇，于 site 文件夾中。
4邑商、推送 mkdocs.yml 摄咆、docs、site到倉庫人断。
5吭从、開啟GiteePages服務，選擇對應分支恶迈。
可參考此倉庫 https://gitee.com/xy180/plain-mkdocs http://xy180.gitee.io/plain-mkdocs/1/site
本地調(diào)試：
安裝 python 及 mkdocs
相關命令
mkdocs serve
mkdocs build
參考：
https://www.cnblogs.com/yywBlogW/p/11362889.html
