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: Build and Deploy ZeroPress Docs to GitHub Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| # Build job: Builds the documentation using ZeroPress and uploads the built site as an artifact | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v6 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v6 | |
| - name: Build ZeroPress Pages | |
| uses: zeropress-app/zeropress-build-pages@v0 | |
| with: | |
| source: ./documents | |
| destination: ./_site | |
| public-dir: ./public | |
| # theme-path: ./theme-docs | |
| - name: Format generated HTML | |
| run: npx --yes prettier@3.8.3 --config ./.prettierrc.json --ignore-path /dev/null --write "./_site/**/*.html" | |
| - name: Build Pagefind index | |
| run: | | |
| npx --yes pagefind@latest \ | |
| --site ./_site \ | |
| --output-subdir _zeropress/pagefind | |
| cp ./_site/_zeropress/search_pagefind.js ./_site/_zeropress/search.js | |
| rm ./_site/_zeropress/search.json | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v5 | |
| # Deploy job: Deploys the built site to GitHub Pages using the artifact from the build job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 |