browsertrix/frontend/docs
Ilya Kreymer 99115473e5
Docs: Add API Reference as top-level nav (#2180)
can either link to redoc hosted elsewhere or make a local copy:
- for local frontend build, just redirect to
http://localhost:30870/api/redoc
- for deployment, make local copy: run copy-api-docs.sh, copy locally
from prod and serve at /api/
- copy-api-docs.sh copies openapi.json, redoc and logo to /api/ dir
- if analytics enabled, also injects analytics scripts
- for local testing, run copy-api-docs.sh and then run mkdocs serve
- ci: copy from prod server
- fixes #1582
2024-11-27 17:00:54 -08:00
..
docs Docs: Add API Reference as top-level nav (#2180) 2024-11-27 17:00:54 -08:00
.gitignore
copy-api-docs.sh Docs: Add API Reference as top-level nav (#2180) 2024-11-27 17:00:54 -08:00
mkdocs.yml Docs: Add API Reference as top-level nav (#2180) 2024-11-27 17:00:54 -08:00