docs: migrate to mdbook

This commit is contained in:
Amaan Qureshi 2024-12-24 00:43:07 -05:00
parent 201b41cf11
commit 043969ef18
57 changed files with 5114 additions and 3622 deletions

43
.github/workflows/docs.yml vendored Normal file
View file

@ -0,0 +1,43 @@
name: Deploy Docs
on:
push:
branches:
- "master"
jobs:
deploy-docs:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install mdbook
env:
GH_TOKEN: ${{ github.token }}
run: |
jq_expr='.assets[] | select(.name | contains("x86_64-unknown-linux-gnu")) | .browser_download_url'
url=$(gh api repos/rust-lang/mdbook/releases/latest --jq "$jq_expr")
mkdir mdbook
curl -sSL "$url" | tar -xz -C mdbook
printf '%s/mdbook\n' "$PWD" >> "$GITHUB_PATH"
- name: Build Book
run: mdbook build docs
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/book
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4