fix: Conform README syntax to mdbook requirements. #11
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
| name: Build, test and deploy mdbook tech docs | |
| on: | |
| # SWITCH TO [ master ] FOR push ONLY BEFORE LANDING | |
| push: | |
| branches: [ "*" ] | |
| pull_request: | |
| branches: [ "*" ] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write # To push a branch | |
| pull-requests: write # To create a PR from that branch | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - run: (test -x $HOME/.cargo/bin/mdbook || cargo install mdbook) | |
| - run: mdbook build tech-docs && mdbook test tech-docs | |
| - uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: tech-docs/book # The folder the action should deploy. |