mdbook.yml

# Build our user documentation using mdbook and publish to GitHub Pages

name: Build documentation

on: workflow_dispatch


jobs:
  build-mdbook:
    runs-on: ubuntu-latest

    permissions:
      contents: write
      pages: write
      id-token: write # To update the deployment status

    name: Build documentation with mdbook and deploy to GitHub pages
    steps:
      - uses: dtolnay/rust-toolchain@nightly

      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install latest mdbook
        run: |
          cargo install mdbook
          cargo install mdbook-admonish
          # tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
          # url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
          #mkdir mdbook
          # curl -sSL $url | tar -xz --directory=./mdbook
          # echo `pwd`/mdbook >> $GITHUB_PATH

      - name: Build book
        run: |
          mdbook-admonish install doc
          cd doc && mdbook build

      - name: Setup GitHub Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: 'doc/book'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2