e2025dac4b
- local deploy update: add collapsible details blocks for vendor-specific instructions, move installing section before running - add missing docs on how to run docs - fix doc typos
17 lines
600 B
Markdown
17 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)
|