通过 Github Actions 部署 Mkdocs 文档
Mkdocs 是一个采用 Python 构建轻量级的静态 HTML 在线文档框架,内置部署到 Github Pages 的功能。我用来创建实践指南,用来做个人的知识积累。
安装 Mkdocs 以及 Mkdocs 主题
Mkdocs 以及主题都通过pip
安装,例如我采用的mkdocs-material主题,如下所示:
pip install --user mkdocs mkdocs-material
值得一说的是,如果你安装主题,mkdocs 会作为依赖被安装。
更多的主题请参考 Wiki 页:https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
创建并测试站点
通过mkdocs new <目录>
就可以快速创建文档站点。目录里会生成mkdocs.yml
文件和docs
目录,目录内有默认的index.md
文件,你可以修改和增加文件。
在所在目录执行mkserve
,你就可以在http://localhost:8000看到初始化的文档。Mkdocs 会监测目录的改动并重新生成站点更新浏览器。
但如果你修改了配置,比如主题。就有可能出错中断进程。
这时站点还没有加载主题,你要修改mkdocs.yml
,增加theme
配置:
theme: name: materiallanguage: zhhighlightjs: true
不同的主题有不同的参数配置,详情可以参考对应主题的文档。
HTML 生成和部署
执行mkdocs build
会新建site
目录,并将 markdown 文件构建为 html 文件。
执行mkdocs gh-deploy
就可以site
中的 html 内容提交到代码仓库的gh-pages
分支上,你要在 Github 上 代码库的配置中起用 Pages 才可以看见站点,地址是 https://<你的用户名>.github.io/<你的代码仓库>
。
通过 Github Actions 部署到 Github Pages
我们可以用 Github Actions 把上述的构建和发布工作自动化,只需要在代码库上新建.github/workflow/gh-deploy.yml
文件,内容如下:
name: Deploy to Github Pageson:push:branches:- master- mainjobs:deploy:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v2- uses: actions/setup-python@v2with:python-version: 3.x- uses: actions/cache@v2with:key: ${{ github.ref }}path: .cache- run: pip install mkdocs-material- run: mkdocs gh-deploy --force
提交后,你就可以看到自己的站点自动部署到 Github Pages。未来的提交也会出发这个流程。
http://www.taodudu.cc/news/show-4721672.html
相关文章:
- 全球首个开源图像识别系统上线了!
- Ceph部署(一)集群搭建
- Ceph部署(二)RGW搭建
- 前端访问不到本地图片,IDEA设置Tomcat虚拟路径
- org.activiti.engine.ActivitiIllegalArgumentException: inputStream for resource '**' is null 的解决办法
- mvn -deploy 报错 Failed to deploy artifacts: Could not transfer artifact
- 解决idea运行Tomcat报错:Unable to ping server at localhost:1099
- java eclipse如何把项目路径改成自己本地tomcat的路径
- k8s-deployment-5
- Artifact storage:war exploded: Error during artifact deployment. See server log for details 之一种解决方法
- 关于 Kubernetes中API Server授权(RBAC)管理的一些笔记
- 前端开发:npm install报错npm ERR! enoent ENOENT:no such file or directory, open…的解决方法
- K8S系列:Deployment更新、锁定、解锁、回滚版本
- 如何使用 mps 开发原生小程序
- 三个微内核和四个名字的故事
- springMVC开发过程中遇到的404错误的两种情况总结
- POJ Oulipo(KMP模板题)
- if语句的使用
- 习题
- TensorFlow练手项目三:使用VGG19迁移学习实现图像风格迁移
- seL4之hello-2旅途(完成更新)
- mysql mmm 互备_mysql 主主互备快速配置(备忘留存)
- [kuangbin带你飞]专题十二 基础DP1
- mysql中flush tables和flush tables with read lock详解
- 洛谷P3879 [TJOI2010] 阅读理解 题解
- 【JZOJ 省选模拟】我的朋友们
- js-前端video播放器
- okl4 linux,数据接入 API
- FC12下OKL4编译环境的搭建
- 2017计算机二级c语言试题,2017年计算机二级C语言试题
通过 Github Actions 部署 Mkdocs 文档相关推荐
- GitHub Actions 部署 VuePress 文档
GitHub Actions 是 GitHub 的持续集成服务,于2018年10月推出.这些天,我一直在试用,觉得它非常强大,有创意,比 Travis CI 玩法更多. 本文是一个简单教程,演示如何使 ...
- 利用Github Actions部署自动更新PaddleOCR指定代码到指定仓库
目录 引言 需求描述 解决方法 采用Github Actions功能 具体代码 总结 参考资料 引言 首先说呢,我也不想重复造轮子, 但是无奈,网上博客看了一大圈,却始终没有找到自己需要的东西 需求描 ...
- java计算机毕业设计智友少儿编程学习平台源码+mysql数据库+系统+部署+lw文档
java计算机毕业设计智友少儿编程学习平台源码+mysql数据库+系统+部署+lw文档 java计算机毕业设计智友少儿编程学习平台源码+mysql数据库+系统+部署+lw文档 本源码技术栈: 项目架构 ...
- 【云原生之Docker实战】使用Docker部署ShowDoc文档工具
[云原生之Docker实战]使用Docker部署ShowDoc文档工具 一.ShowDoc介绍 1.ShowDoc简介 2.ShowDoc功能 二.检查docker版本 三.检查docker状态 四. ...
- 【云原生之Docker实战】使用Docker部署Mindoc文档管理平台
[云原生之Docker实战]使用Docker部署Mindoc文档管理平台 一.Mindoc介绍 1.Mindoc简介 2.Mindoc功能 二.检查宿主机系统版本 1.检查操作系统版本 2.检查系统内 ...
- java计算机毕业设计游泳馆信息管理系统源码+数据库+系统+部署+lw文档
java计算机毕业设计游泳馆信息管理系统源码+数据库+系统+部署+lw文档 java计算机毕业设计游泳馆信息管理系统源码+数据库+系统+部署+lw文档 本源码技术栈: 项目架构:B/S架构 开发语言: ...
- Ubuntu部署TeamTalk文档
Ubuntu16.04 64bit 部署TeamTalk文档 准备 ubuntu16.04 64bit root用户 apt-get update 安装mysql(5.7.29) apt-get in ...
- 大商创虚拟服务器安装教程,【大商创X】一键部署安装文档教程解析
原标题:[大商创X]一键部署安装文档教程解析 注意事项: 请确保服务器环境为干净的环境 只支持centos6.Centos7操作系统,其他系统不支持! 一键部署大商创X环境 1.通过xshell等工具 ...
- java计算机毕业设计智能旅游电子票务系统演示录像2020源码+mysql数据库+系统+部署+lw文档
java计算机毕业设计智能旅游电子票务系统演示录像2020源码+mysql数据库+系统+部署+lw文档 java计算机毕业设计智能旅游电子票务系统演示录像2020源码+mysql数据库+系统+部署+l ...
最新文章
- SAP零售行业解决方案初阶 7 - 自动补货
- batch_size 和 fetch_size作用
- php使用supervisor管理进程脚本
- 【Hibernate】hibernate主键生成策略与配置详解
- smpp客户端_SMPP Java示例(客户端)
- c语言 结构体的输入输出_C语言的控制结构和输入输出
- appium分层自动化的封装
- 对《构建之法——现代软件工程》13-17章的困惑与思考
- 针对利用tzselect修改时间及ln -sf 修改系统时间不好使的情况 linux 6.5
- Python中文手册——开胃菜
- 【预测模型-ELAMN预测】基于海鸥算法优化ELMAN神经网络实现数据回归预测
- 解决laydate坑之chang回调无效 range开启
- 工业相机IO口控制STM32输出PWM波
- centos7 Redis多机多节点集群部署
- 【 信息搜集的内容,信息搜集的方法,信息搜集的工具,信息搜集结果的利用等】
- 服务器信号满格网速很慢,手机信号满格但网速很慢 可能是这5个原因
- 彻底理解vue的钩子函数,vue的生命周期理解,什么是vue的生命周期,钩子函数
- android仿京东跑马灯,RecyclerView实现跑马灯效果
- PIPIOJ1099PIPI的油田
- iphone 控制android手机,如何从Apple手机远程控制Android手机