mirror of
https://github.com/webrecorder/browsertrix-crawler.git
synced 2025-10-19 14:33:17 +00:00
e1fe028c7c
Fixes #493 This PR updates the documentation for Browsertrix Crawler 1.0.0 and moves it from the project README to an MKDocs site. Initial docs site set to https://crawler.docs.browsertrix.com/ Many thanks to @Shrinks99 for help setting this up! --------- Co-authored-by: Henry Wilkinson <henry@wilkinson.graphics> Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
23 lines
591 B
Markdown
23 lines
591 B
Markdown
# Documentation
|
|
|
|
This documentation is built with the [Mkdocs](https://www.mkdocs.org/) static site generator.
|
|
|
|
## Docs Setup
|
|
|
|
Python is required to build the docs, then run:
|
|
|
|
pip install mkdocs-material
|
|
|
|
|
|
## Docs Server
|
|
|
|
To start the docs server, simply run:
|
|
|
|
mkdocs serve
|
|
|
|
The documentation will then be available on `http://localhost:8000/`
|
|
|
|
The command-line options are rebuilt using the `docs/gen-cli.sh` script.
|
|
|
|
Refer to the [Mkdocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) pages
|
|
for more info about the documentation.
|