browsertrix/docs/index.md
Henry Wilkinson 0a1f5eff8e
Docs: adds mkdocs features, adds theming (#728)
* Add stylesheet & mkdocs features

- Adds a custom stylesheet & brand colours
- Adds Recursive as the code font
- Adds repo info to the nav bar
- Adds auto tracking ID links for deep linking to sections as users scroll the page
- Index pages are now a part of their section as determined by their H1
- Removes mkdocs info from future footer

* Reorganize content

- Renames "Dev" to "Develop" for improved navigation labels
- Adds links to tools the first time they're mentioned
- Rewords part of the homepage
- Hides section navigation on the homepage (now we don't have a blank section nav bar!
- Adds some syntax highlighting
- Removes some manual word wrapping — this was done very rarely / inconsistently

* Rename "Developer Docs" index page

- Better title for sidebar

* Update docs.md

- Adds links to tools
- Adds future docs style guide section
- Updates name and makes it an H1

- Replaces hyphens on the homepage with em dashes

* deployment index page: changed title, removed non-k8s section, cleaned up intro
* develop index page: changed title
fixed typo on main page

---------

Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2023-04-06 02:44:19 -07:00

1.1 KiB

hide
navigation
toc

Home

Welcome to the Browsertrix Cloud official user guide and developer docs. These docs will contain the following sections.

  • Deployment Guide — How to install and deploy Browsertrix Cloud on your local machine, or in the cloud.
  • Developer Docs — Information on developing Browsertrix Cloud itself.
  • User Guide — Instructions and reference for using Browsertrix Cloud.

If you are unfamiliar with Browsertrix Cloud, please check out our website, or the main repository at https://github.com/webrecorder/browsertrix-cloud

Our docs are still under construction. If you find something missing, chances are we haven't gotten around to writing that part yet. If you find typos or something isn't clear or seems incorrect, please open an issue and we'll try to make sure that your questions get answered here in the future!