Update README.md #41
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: Docs | |
| # Build the landing page (root index.html + assets/) + MkDocs site, merge | |
| # them into a single artifact, and deploy to GitHub Pages. | |
| # | |
| # Final routing: | |
| # / → root index.html (project landing) | |
| # /assets/* → static assets (SVG / screenshots) | |
| # /docs/ → MkDocs Material site | |
| # | |
| # Pages was enabled once via `gh api -X POST /repos/.../pages`. If you fork | |
| # this repo you can run the same command, or click Settings → Pages. | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'docs/**' | |
| - 'mkdocs.yml' | |
| - '.github/workflows/docs.yml' | |
| - 'README.md' | |
| - 'index.html' | |
| - 'assets/**' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages-docs | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| cache: pip | |
| - name: Install MkDocs + Material | |
| run: pip install "mkdocs>=1.6" "mkdocs-material>=9.5" | |
| - name: Build MkDocs to _site/docs | |
| run: mkdocs build --strict --site-dir _site/docs | |
| - name: Copy landing page + root assets | |
| run: | | |
| cp index.html _site/index.html | |
| cp -r assets _site/assets | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| # Pages was one-shot enabled via `gh api -X POST .../pages -f build_type=workflow`. | |
| # enablement:true would need Pages-write token scope which the default | |
| # GITHUB_TOKEN doesn't have ("Resource not accessible by integration"). | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: _site | |
| deploy: | |
| needs: build | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |