browsertrix/docs/index.md
Henry Wilkinson fa194c3d0d
Docs: Update docs theme (#1594)
Partially addresses #1241 

### Changes
- Adds Browsertrix logo to readme
- It detects if you're in light or dark mode and adjusts the text color
accordingly! _The future is now!_
- Minor readme updates
- Updates icon and adds favicon SVGs to the docs
- This does not yet use Konsole for the docs site title. Will have to
sort this out later along with private hosting for that font.
- Updates docs theme to use new brand colours — picked the green for
this one, will probably be consistent across all of Webrecorder's MKDocs
sites.
2024-03-16 15:09:31 -07:00

18 lines
948 B
Markdown

---
hide:
- navigation
- toc
---
# Home
Welcome to the Browsertrix official user guide and developer docs. These docs will contain the following sections.
- [Deployment Guide](deploy/index.md) — How to install and deploy Browsertrix on your local machine, or in the cloud.
- [Developer Docs](develop/index.md) — Information on developing Browsertrix itself.
- [User Guide](user-guide/index.md) — Instructions and reference for using Browsertrix.
If you are unfamiliar with Browsertrix, please check out [our website](https://browsertrix.cloud), or the main repository at [https://github.com/webrecorder/browsertrix-cloud](https://github.com/webrecorder/browsertrix-cloud)
If something is missing, unclear, or seems incorrect, please open an [issue](https://github.com/webrecorder/browsertrix-cloud/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and we'll try to make sure that your questions get answered here in the future!