Stowage/browsertrix-crawler
2
0
Fork 0
mirror of https://github.com/webrecorder/browsertrix-crawler.git synced 2025-10-19 14:33:17 +00:00
Code Issues Projects Releases Packages Wiki Activity
browsertrix-crawler/docs/docs/develop/docs.md
Tessa Walsh e1fe028c7c
Add MKDocs documentation site for Browsertrix Crawler 1.0.0 (#494) 
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>
2024-03-16 14:59:32 -07:00

591 B
Raw Blame History

Documentation

This documentation is built with the Mkdocs 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 and Material for MkDocs pages for more info about the documentation.