feat: deploy docs to github pages on github actions

This commit is contained in:
debugtalk
2021-11-19 14:38:19 +08:00
parent d306452b19
commit c3f80d3d1e
3 changed files with 22 additions and 5 deletions

18
.github/workflows/deploy-mkdocs.yml vendored Normal file
View File

@@ -0,0 +1,18 @@
name: Deploy docs to GitHub Pages
on:
push:
branches:
- main
jobs:
deploy:
name: Deploy docs to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material # including mkdocs
- run: mkdocs gh-deploy

View File

@@ -238,7 +238,7 @@ func TestCaseDemo(t *testing.T) {
Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](sponsors.md))
### 金牌赞助商(Gold Sponsor
### Gold Sponsor
[<img src="assets/hogwarts.jpeg" alt="霍格沃兹测试开发学社" width="400">](https://ceshiren.com/)
@@ -246,7 +246,7 @@ Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](sponsors.md))
> [进入测试开发技术能力测评!](http://qrcode.testing-studio.com/f?from=httprunner&url=https://ceshiren.com/t/topic/14940)
### 开源服务赞助商(Open Source Sponsor
### Open Source Sponsor
[<img src="assets/sentry-logo-black.svg" alt="Sentry" width="150">](https://sentry.io/_/open-source/)

View File

@@ -1,6 +1,5 @@
# install mkdocs
# $ pip install mkdocs # 1.1.2
# $ pip install mkdocs-material # 5.2.2
# install mkdocs and material design
# $ pip install mkdocs-material
# usage
# $ mkdocs serve # build docs and preview