Adapted with thanks from the CSCI 1710 mdbook, set up by David Fryd.
This is the source for the 0320 notes, which were formerly located on HackMD. It is built using mdbook.
See the user guide https://rust-lang.github.io/mdBook/guide/installation.html for more information.
- Install Rust & Cargo from this link. You'll probably need to have at least Rust 1.75.0.
- Run
cargo install mdbook
- Run
cargo install mdbook-admonish
- Run
cargo install mdbook-katex
cd book
andmdbook serve --open
to open the docs in a browser; mdbook will automatically rebuild the output and automatically refresh your web browser when changes are made.
Check out the rest of the docs here: https://rust-lang.github.io/mdBook/guide/creating.html
The book
subfolder contains the mdbook
config and source. After building, the book
sub-subfolder will contain the built notes HTML. The .github
folder contains a workflow to automatically deploy the built HTML when new source is pushed to the main
branch.