/forge-documentation

Primary LanguageCSS

Forge Documentation mdbook

The deployed documentation is viewable here: https://csci1710.github.io/forge-documentation/

About

This is the source for the Forge documentation. It is built using mdbook.

See the user guide https://rust-lang.github.io/mdBook/guide/installation.html for more information.

TL;DR:

  1. Install Rust & Cargo from https://rust-lang.github.io/mdBook/guide/installation.html#:~:text=Rust%20installation%20page
  2. Run cargo install mdbook
  3. cd forge-docs-book and mdbook 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

(TODO: Add more info about contributing and stuff here...)