Update and rename build_mkdocs.yml to mkdocs.yml #1
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: MkDocs - Build & Deploy | |
| on: | |
| push: | |
| branches: [ "Main" ] | |
| pull_request: | |
| branches: [ "Main" ] | |
| workflow_dispatch: | |
| jobs: | |
| build_mkdocs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.9 | |
| - run: pip install \ | |
| mkdocs-material | |
| - run: mkdocs gh-deploy --config-file example-mkdocs/mkdocs.yml --force | |
| deploy_mkdocs: | |
| needs: build_mkdocs | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: gh-pages | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: '.' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |