Begin work on docs book (#156) #6
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: Deploy mdBook to GitHub Pages | |
on: | |
push: | |
branches: | |
- "**" | |
paths: | |
- 'docs/**' | |
- '.github/workflows/mdbook.yml' | |
jobs: | |
build: | |
name: Build Book - mdbook | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- uses: actions-rs/toolchain@v1 | |
with: | |
toolchain: stable | |
override: true | |
- name: Rust Cache | |
uses: Swatinem/[email protected] | |
- name: Install mdBook | |
run: cargo install mdbook | |
- name: Build the book | |
run: cd docs && mdbook build | |
- name: Deploy to GitHub Pages | |
if: github.ref == 'refs/heads/main' | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/book |