Update docs to: Fix docs index.md #50
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: | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build_mkdocs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.9 | |
| - name: Install packages with pip | |
| run: pip install \ | |
| mkdocs-material | |
| mkdocstrings[python] | |
| - name: Build with MkDocs | |
| run: mkdocs gh-deploy --config-file mkdocs.yml --force | |
| deploy_mkdocs: | |
| needs: build_mkdocs | |
| environment: | |
| name: github-pages | |
| url: https://text-forge.github.io/editor | |
| 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 |