f6bab4f26c
- Renames "Dev" to "Develop" for improved navigation labels - Deployment docs are now located under a larger "Development" section (fewer nav bar choices & realistically I think anyone who wants to do one is going to be referring to the other) - Adds links to tools the first time they're mentioned - Rewords part of the homepage - Hides section navigation on the homepage (now we don't have a blank section nav bar! - Adds some syntax highlighting - Removes some manual word wrapping — this was done very rarely / inconsistently
16 lines
600 B
Markdown
16 lines
600 B
Markdown
## Updating the Docs
|
|
|
|
This documentation is built with MkDocs and configured via `mkdocs.yml` in the project root.
|
|
|
|
The docs can be found in the `./docs` subdirectory.
|
|
|
|
To build this documentation locally, install Material for MkDocs with pip:
|
|
|
|
```shell
|
|
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](https://docs.browsertrix.cloud) are created from the main branch of [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud)
|