14 lines (10 loc) · 448 Bytes

SUSY Dev Docs

To develop locally, install Rust, and then:

git clone https://github.com/SymmetricDevs/Dev-Docs.git
cd Dev-Docs
cargo install mdbook mdbook-mermaid  mdbook-admonish mdbook-linkcheck mdbook-emojicodes
mdbook serve

Or if you're a freak there's the nix flake ;)

For most PRs, however, it's probably not necessary to actually install mdbook and check because it's just Markdown.