Skip to content

Update README.md

Update README.md #301

Workflow file for this run

name: Deploy Documentation
on:
workflow_dispatch:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Rust
uses: ATiltedTree/setup-rust@v1
with:
rust-version: stable
- name: Cache Dependencies
uses: actions/cache@v3
with:
path: ~/.cargo
key: cargo-cache-${{ hashFiles('Cargo.lock') }}
- name: Install dependencies
run: |
cargo install mdbook mdbook-mermaid mdbook-toc
- name: Build MDBook
run: |
if [ -d "docs" ]; then
cd docs
mdbook build
else
echo "Docs folder not found."
fi
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/book
single-commit: true