[TASK] Split the README and publish the documentation as a site #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: Pages | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'docs/**' | |
| - 'Documentation/Images/**' | |
| - '.github/workflows/pages.yml' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # One deployment at a time, and a newer push wins. | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: true | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deploy.outputs.page_url }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install the build dependencies | |
| run: pip install --quiet markdown pillow | |
| # docs/build.py renders Documentation/*.md and CHANGELOG.md into the | |
| # landing page's own styling and copies in only the screenshots they | |
| # reference, so neither the HTML nor the images are stored twice in the | |
| # repository. It also writes .nojekyll, which keeps Pages from running | |
| # the markdown in the repository through Jekyll. | |
| - name: Build the site | |
| run: python3 docs/build.py _site | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: _site | |
| - name: Deploy | |
| id: deploy | |
| uses: actions/deploy-pages@v4 |