This repository is a documentation template using mdbook
.
If you'd like to see a deployed version of this repository: Demo
- Run
make install
to install the dependencies for this project. (This currently only works on Mac). - Otherwise, the only dependency required is
mdbook
, which can be found here: Mdbook
- Since Mdbook only shows files that are linked to in
SUMMARY.md
, there is a python helper file (located inbin/generate_toc
) that will generate an up to date version of your book by running it. make
ormake serve
will serve an HTML version of your documentation on localhost:3000.make build
will generate a deployable HTML version of your documentation in thebook
directory.make clean
will delete the contents of thebook
directory.