From d5c5e5ce67675a35ba8bd0e53c2f6a28181f9e4e Mon Sep 17 00:00:00 2001 From: BoYanZh Date: Thu, 10 Jun 2021 23:50:01 +0800 Subject: [PATCH] docs: add mkdocs --- .github/workflows/mkdocs.yml | 15 +++++++++++++++ docs/index.md | 3 +++ mkdocs.yml | 5 +++++ 3 files changed, 23 insertions(+) create mode 100644 .github/workflows/mkdocs.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 0000000..710c8c6 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,15 @@ +name: mkdocs +on: + push: + branches: + - master +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..cc0b5ff --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Welcome + +In progress... diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..1d48408 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: Joint Teapot +repo_url: https://github.com/BoYanZh/joint-teapot +repo_name: BoYanZh/joint-teapot +theme: + name: material