96afa408d9
- Adds links to tools - Adds future docs style guide section - Updates name and makes it an H1
680 B
680 B
Writing documentation
Our documentation is built with Material for MkDocs and configured via mkdocs.yml in the project root.
The docs can be found in the ./docs subdirectory.
To build the docs locally, install Material for MkDocs with pip:
pip install mkdocs-material
In the project root directory run mkdocs serve to run a local version of the documentation site.
The docs hosted on docs.browsertrix.cloud are created from the main branch of https://github.com/webrecorder/browsertrix-cloud
Docs style guide
TODO!