From c3f80d3d1e1a41f69a80dd454268c03eb5579ceb Mon Sep 17 00:00:00 2001
From: debugtalk <mail@debugtalk.com>
Date: Fri, 19 Nov 2021 14:38:19 +0800
Subject: [PATCH] feat: deploy docs to github pages on github actions

---
 .github/workflows/deploy-mkdocs.yml | 18 ++++++++++++++++++
 docs/README.md                      |  4 ++--
 mkdocs.yml                          |  5 ++---
 3 files changed, 22 insertions(+), 5 deletions(-)
 create mode 100644 .github/workflows/deploy-mkdocs.yml

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
 
 [<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/)
 
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