diff --git a/.github/workflows/deploy-mkdocs.yml b/.github/workflows/deploy-mkdocs.yml
new file mode 100644
index 00000000..3d75e2fb
--- /dev/null
+++ b/.github/workflows/deploy-mkdocs.yml
@@ -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
diff --git a/docs/README.md b/docs/README.md
index bb26aa55..fe377703 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -238,7 +238,7 @@ func TestCaseDemo(t *testing.T) {
Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](sponsors.md))
-### 金牌赞助商(Gold Sponsor)
+### Gold Sponsor
[
](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
[
](https://sentry.io/_/open-source/)
diff --git a/mkdocs.yml b/mkdocs.yml
index 1e4cfe2d..296bd1a7 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -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