name: mdBook
on:
push:
branches: [ main ]
paths:
- "docs/**"
- ".github/workflows/mdbook.yml"
pull_request:
branches: [ main ]
paths:
- "docs/**"
- ".github/workflows/mdbook.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
env:
CARGO_TERM_COLOR: always
MDBOOK_VERSION: "0.5.2"
MDBOOK_MERMAID_VERSION: "0.17.0"
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache dependencies
uses: Swatinem/rust-cache@v2
- name: Install mdBook
uses: taiki-e/install-action@v2
with:
tool: mdbook@${{ env.MDBOOK_VERSION }}
- name: Install mdbook-mermaid
uses: taiki-e/install-action@v2
with:
tool: mdbook-mermaid@${{ env.MDBOOK_MERMAID_VERSION }}
- name: Install mdbook-termlink
run: cargo install mdbook-termlink --locked
- name: Setup Mermaid
run: mdbook-mermaid install docs
- name: Build documentation
run: mdbook build docs
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/book
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4