关于markdown:gitlabgithubgitee布署mkdocs主题仓库

gitlab、github、gitee 布署 mkdocs 主题仓库

旧址   布署 mkdocs   calligraphy

1、概述

mkdocs 作用
在 git 平台创立 mkdocs 主题仓库，主动将 markdown 文件生成动态网页。官网  https://www.mkdocs.org/
简介 & 主题   https://www.jianshu.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 主题仓库（推送文件主动布署）创立办法：1、创立 mkdocs.yml、.gitlab-ci.yml 文件。2、创立 docs 目录，markdown 文件放在此处。3、推送到仓库。可 fork 此仓库 https://gitlab.com/xuyq123/plain-mkdocs    https://xuyq123.gitlab.io/plain-mkdocs
   留神：若部署失败，可在 CI/CD --> Jobs 查看起因，批改 .gitlab-ci.yml 文件。本地调试：装置 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



主题总结
    mkdocs      默认主题，速度极快。菜单横向。蓝边白底。不够好看。评级四星。material    速度个别。菜单竖向，左侧整体文件构造，右侧文件目录。紫边白底。评级四星。readthedocs 速度个别。菜单竖向。展现 markdown 文件目录构造。黑边白底。评级四星。sandstone   加载挺快。菜单横向。黑边白底。评级四星。litera      加载挺快。菜单横向。天蓝边白底。评级四星。lumen       加载挺快。菜单横向。海蓝边白底。评级四星。spacelab    加载挺快。菜单横向。深蓝边白底。评级四星。cluster        加载挺快。菜单横向。灰边白底。评级四星。slate        加载挺快。菜单横向。黑边黑底。评级四星。simplex        加载挺快。菜单横向。深红边白底。评级四星。united        加载挺快。菜单横向。橙红边白底。评级四星。cinder        速度个别，不显示文件夹中的下拉文档。展现 markdown 文件目录构造。菜单横向。黑边白底。适宜单级目录文件。评级三星。bootstrap4  速度相当慢。菜单横向。黑边白底。评级二星。gitbook     速度个别。菜单竖向，灰边白底。有版权广告去不掉。评级二星。ivory       速度相当慢。菜单竖向，黑边白底。评级二星。

3、github 布署 mkdocs

github mkdocs 主题仓库（mkdocs gh-deploy 一键布署）创立办法：1、创立 mkdocs.yml、README.md、.gitignore 文件。创立 docs 目录，markdown 文件放在此处。2、本地调试 mkdocs serve   拜访：http://127.0.0.1:8000/。推送上述三个文件。3、一键布署 mkdocs gh-deploy（主动生成 gh-pages 分支，公布 GithubPages）可 fork 此仓库 https://github.com/scott180/plain-mkdocs     https://scott180.github.io/plain-mkdocs/

前期更新文件，只需执行 mkdocs gh-deploy。本地调试：装置 python 及 mkdocs 
    相干命令 
         mkdocs serve
         mkdocs gh-deploy 
    
参考：https://www.cnblogs.com/paulwhw/p/12725523.html
    

4、gitee 布署 mkdocs

gitee mkdocs 主题仓库（GiteePages 服务布署目录）创立办法：1、创立 mkdocs.yml。创立 docs 目录，markdown 文件放在此处。2、本地调试 mkdocs serve   拜访：http://127.0.0.1:8000/。3、mkdocs build  生成动态文件，于 site 文件夹中。4、推送 mkdocs.yml、docs、site 到仓库。5、开启 GiteePages 服务，抉择对应分支。可参考此仓库 https://gitee.com/xy180/plain-mkdocs     http://xy180.gitee.io/plain-mkdocs/1/site
   
本地调试：装置 python 及 mkdocs 
    相干命令 
         mkdocs serve
         mkdocs build
         
参考：https://www.cnblogs.com/yywBlogW/p/11362889.html

5、示例