docs: add mkdocs
This commit is contained in:
parent
7897625d69
commit
d5c5e5ce67
15
.github/workflows/mkdocs.yml
vendored
Normal file
15
.github/workflows/mkdocs.yml
vendored
Normal file
|
@ -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
|
3
docs/index.md
Normal file
3
docs/index.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# Welcome
|
||||
|
||||
In progress...
|
5
mkdocs.yml
Normal file
5
mkdocs.yml
Normal file
|
@ -0,0 +1,5 @@
|
|||
site_name: Joint Teapot
|
||||
repo_url: https://github.com/BoYanZh/joint-teapot
|
||||
repo_name: BoYanZh/joint-teapot
|
||||
theme:
|
||||
name: material
|
Loading…
Reference in New Issue
Block a user