Project Books Docs

Documentation site made using Material for MkDocs.

Go to https://project-books.github.io/ to see it live.

image

Getting started locally

Note: these steps only need to be followed if you would like to contribute to our documentation

Prerequisites:

  • pip (Python package manager)

To run the site locally run

mkdocs serve

On Windows, you may need to run python -m mkdocs serve instead.

Then, go to localhost:8080to see the website.