gitlab、github、gitee布署mkdocs主题仓库
gitlab、github、gitee布署mkdocs主题仓库
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、示例
仓库 | 地址 | 备注 |
---|---|---|
gitlab | plain-mkdocs 网页 <br/>plain-pip-mkdocs 网页 <br/>plain-mkdocs-gitbook 网页 | gitlab布署mkdocs:配置文件.gitlab-ci.yml。 |
github | plain-mkdocs 网页 <br/>plain-pip-mkdocs 网页 <br/>plain-mkdocs-serve 网页 | github布署mkdocs:命令mkdocs gh-deploy 。 |
gitee | plain-mkdocs 网页1 网页2 网页3 | gitee布署mkdocs:mkdocs build 布署目录。 |
note-mkdocs | gitlab note-mkdocs 网页1 网页2 <br/>github note-mkdocs 网页<br/>gitee plain-mkdocs 网页 | 个人笔记,含书法练习及java笔记。 |
myblog-mkdocs | gitlab myblog-mkdocs 网页 <br/>github myblog-mkdocs 网页<br/>gitee myblog-mkdocs | 我的博客 |
2 声望
0 粉丝
推荐阅读
书法练习轨迹ReadMe
幼时接触书法,学而未成。 二零二零九月(庚子年酉月),有感大丈夫处身立世必有一技之长。或曰君子慎独,一人之际,奋发之时。尝学英语,练吹埙,打篮球,志不在此,无有所成。 历年从事之业,设计、物流、销售...
jack阅读 1.7k
git 常用命令 记录
有错误和改进的地方望留言,谢谢 : )顺便推荐一下,git入门教程Git 教程图解 GitPro Git 2(中文版)Git 使用Git 使用规范流程Git 工作流程Commit message 和 Change log 编写指南全局设置git config --system //...
Luff阅读 3.2k
git/pip/easy_install/apt代理/源设置
在公司内网环境中,访问公网往往需要经过公司的代理,对于浏览器、IDE等开发工具,都提供了设置代理的配置,而git、pip、easy_install等CLI工具,则需要通过命令或配置文件进行代理设置;对于Python、Ubuntu、Mav...
乘着风赞 1阅读 5.5k
低代码开发重要工具:jvs-logic(逻辑引擎)2.1.6版本功能清单
逻辑引擎是一种能够处理逻辑表达式的程序,它能够根据用户输入的表达式计算出表达式的值。在实际应用中,逻辑引擎通常被用于处理规则引擎、决策系统、业务规则配置等领域,具有广泛的应用前景。前面几期我们了解...
软件部长赞 2阅读 422
被吐槽 GitHub仓 库太大,直接 600M 瘦身到 6M,这下舒服了
忙里偷闲学习了点技术写了点demo代码,打算提交到我那 2000Star 的Github仓库上,居然发现有5个Issues,最近的一条日期已经是2022/8/1了,以前我还真没留意过这些,我这人懒得很,本地代码提交成功基本就不管了。
程序员小富赞 2阅读 1.4k评论 1
JavaScript实现一个简单的Markdown语法解析器
Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。 它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的 XHTML(或者HTML)文档。这种语言吸收了很多在电子邮件中已有的纯文本标...
TANKING赞 1阅读 673
书写友好的提交信息
其中开头部分表明了本次提交的类型(是添加功能还是修复错误等),范围则描述了修改的影响面,然后是一段简要的描述,更多详细的信息则可以在正文中进行描述。
Kisstar阅读 3k
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。