This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # From https://github.com/mhausenblas/mkdocs-deploy-gh-pages | |
| name: Publish mkDocs via GitHub Pages | |
| # build the documentation whenever there are new commits on main | |
| on: | |
| push: | |
| branches: | |
| - master | |
| # Alternative: only build for tags. | |
| # tags: | |
| # - '*' | |
| jobs: | |
| build: | |
| name: Deploy MkDocs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout main | |
| uses: actions/checkout@v2 | |
| - name: Deploy docs | |
| uses: mhausenblas/mkdocs-deploy-gh-pages@master | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| CONFIG_FILE: mkdocs.yml | |
| REQUIREMENTS: requirements.txt | |
| # CUSTOM_DOMAIN: optionaldomain.com |