The AlgoGators documention can be view here. The documention has been built with the mdBook
tool that allows for straightforward documention hosting.
When making contributions to the "AlgoBook" work with a development branch off of a greater development branch of off of main
. Understand when merging with main, you will kick-off the building and deployment workflows.
To use and view the documentation, install mdBook
either through cargo
or a pre-compiled binary. The process of installation is within mdBook
s documention.
To host and view the documentation, you must have mdBook
installed.
To build:
mdbook build
And to serve:
mdbook serve --open