Update docs.md
- Adds links to tools - Adds future docs style guide section - Updates name and makes it an H1
This commit is contained in:
parent
2afc13e35a
commit
96afa408d9
@ -1,10 +1,10 @@
|
||||
## Updating the Docs
|
||||
# Writing documentation
|
||||
|
||||
This documentation is built with MkDocs and configured via `mkdocs.yml` in the project root.
|
||||
Our documentation is built with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) 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:
|
||||
To build the docs locally, install Material for MkDocs with pip:
|
||||
|
||||
```shell
|
||||
pip install mkdocs-material
|
||||
@ -13,3 +13,7 @@ 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)
|
||||
|
||||
## Docs style guide
|
||||
|
||||
TODO!
|
Loading…
Reference in New Issue
Block a user