diff options
author | Benjamin Brahmer <info@b-brahmer.de> | 2021-05-08 14:34:58 +0200 |
---|---|---|
committer | Benjamin Brahmer <info@b-brahmer.de> | 2021-05-19 14:58:29 +0200 |
commit | 79e469fd335133671185cf8539f77ef38ac3b4e6 (patch) | |
tree | 4e2b7075e85225c9ac93cf78c7ef1e95b78e5ac4 /.github | |
parent | 271b6ee3c993264bd44a966b82f1a5daa85f53ab (diff) |
Refactor News documentation with mkdocs and mkdocs-material
- move all pages to new structure
- use gh-pages to host html version
- use github actions for automatic build
Co-authored-by: anoy <anoymouserver+github@mailbox.org>
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Diffstat (limited to '.github')
-rw-r--r-- | .github/workflows/documentation.yml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..409fb4da8 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,23 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + #CUSTOM_DOMAIN: optionaldomain.com + #CONFIG_FILE: folder/mkdocs.yml + #EXTRA_PACKAGES: build-base + # GITHUB_DOMAIN: github.myenterprise.com
\ No newline at end of file |