ci: add mdbook workflow #1
Workflow file for this run
This file contains 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
| --- | |
| # Build and deploy documentation | |
| name: docs | |
| on: | |
| pull_request: | |
| merge_group: | |
| push: | |
| branches: | |
| - main | |
| - docs/write_docs | |
| permissions: | |
| contents: read | |
| jobs: | |
| mdbook: | |
| permissions: | |
| pages: write | |
| id-token: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Configure GitHub Pages | |
| uses: actions/configure-pages@v3 | |
| - uses: jontze/action-mdbook@v3 | |
| with: | |
| token: ${{secrets.GITHUB_TOKEN}} | |
| # Optional Plugins have to be enabled | |
| use-linkcheck: true | |
| use-mermaid: true | |
| use-toc: true | |
| use-opengh: true | |
| use-admonish: true | |
| use-katex: true | |
| - name: mdbook | |
| run: | | |
| cd docs | |
| mdbook build | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/public | |