improve docs #4
This file contains hidden or 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
| name: Publish docs via GitHub Pages | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - 'docs/**' | |
| workflow_dispatch: # Add this line to enable manual triggering | |
| permissions: | |
| contents: write # Gives write permission to repository contents | |
| jobs: | |
| build: | |
| name: Deploy docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout main | |
| uses: actions/checkout@v4 | |
| - 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 }} | |
| EXTRA_PACKAGES: build-base pygments | |
| #CUSTOM_DOMAIN: optionaldomain.com | |
| #CONFIG_FILE: folder/mkdocs.yml | |
| # GITHUB_DOMAIN: github.myenterprise.com |