Skip to content

Commit

Permalink
Docs: Update docs theme (#1594)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Shrinks99 committed Mar 16, 2024
1 parent e7af081 commit fa194c3
Show file tree
Hide file tree
Showing 8 changed files with 49 additions and 52 deletions.
21 changes: 9 additions & 12 deletions README.md
@@ -1,29 +1,27 @@
# Browsertrix
<div align="center">
<img alt="Browsertrix Logo" src="assets/browsertrix-lockup-color-dynamic.svg" width="90%">
</div>

<p align="center"><img src="/frontend/assets/btrix-cloud.svg" width="128" height="128"></p>
&nbsp;

Browsertrix is an open-source cloud-native high-fidelity browser-based crawling service designed
to make web archiving easier and more accessible for everyone.

The service provides an API and UI for scheduling crawls and viewing results,
and managing all aspects of crawling process. This system provides the orchestration and management around crawling,
while the actual crawling is performed using
[Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl.
The service provides an API and UI for scheduling crawls and viewing results, and managing all aspects of crawling process. This system provides the orchestration and management around crawling, while the actual crawling is performed using [Browsertrix Crawler](https://github.com/webrecorder/browsertrix-crawler) containers, which are launched for each crawl.

See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix Hosting.
See [browsertrix.com](https://browsertrix.com) for a feature overview and information about Browsertrix hosting.

## Documentation

The full docs for using, deploying and developing Browsertrix are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)
The full docs for using, deploying, and developing Browsertrix are available at: [https://docs.browsertrix.cloud](https://docs.browsertrix.cloud)

## Deployment
## Deployment

The latest deployment documentation is available at: [https://docs.browsertrix.cloud/deploy](https://docs.browsertrix.cloud/deploy)

The docs cover deploying Browsertrix in different environments using Kubernetes, from a single-node setup to scalable clusters in the cloud.

Previously, Browsertrix also supported Docker Compose and podman-based deployment. This is now deprecated due to the complexity
of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine.
Previously, Browsertrix also supported Docker Compose and podman-based deployment. This has been deprecated due to the complexity of maintaining feature parity across different setups, and with various Kubernetes deployment options being available and easy to deploy, even on a single machine.

Making deployment of Browsertrix as easy as possible remains a key goal, and we welcome suggestions for how we can further improve our Kubernetes deployment options.

Expand All @@ -37,7 +35,6 @@ Additional developer documentation is available at [https://docs.browsertrix.clo

Please see the GitHub issues and [this GitHub Project](https://github.com/orgs/webrecorder/projects/9) for our current project plan and tasks.


## License

Browsertrix is made available under the AGPLv3 License.
Expand Down
17 changes: 17 additions & 0 deletions assets/browsertrix-lockup-color-dynamic.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/assets/brand/browsertrix-icon-white.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 0 additions & 29 deletions docs/assets/brand/btrix-logo.svg

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/brand/favicon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/index.md
Expand Up @@ -14,4 +14,4 @@ Welcome to the Browsertrix official user guide and developer docs. These docs wi

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)

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](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!
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!
14 changes: 7 additions & 7 deletions docs/stylesheets/extra.css
Expand Up @@ -29,17 +29,17 @@
:root {
--md-code-font: "Recursive", monospace;
--md-text-font: "Inter", "Helvetica", "Arial", sans-serif;
--wr-blue-primary: #2E7CAB;
--wr-orange-primary: #B85D20;
--wr-blue-primary: #0891B2;
--wr-orange-primary: #C96509;
}

[data-md-color-scheme="webrecorder"] {
--md-primary-fg-color: #008873;
--md-primary-fg-color--light: #008873;
--md-primary-fg-color--dark: #003c32;
--md-primary-fg-color: #4D7C0F;
--md-primary-fg-color--light: #0782A1;
--md-primary-fg-color--dark: #066B84;
--md-typeset-color: black;
--md-accent-fg-color: #01b297;
--md-typeset-a-color: #005447;
--md-accent-fg-color: #0782A1;
--md-typeset-a-color: #066B84;
--md-code-bg-color: #F9FAFB;
}

Expand Down
7 changes: 4 additions & 3 deletions mkdocs.yml
@@ -1,6 +1,6 @@
site_name: Browsertrix Cloud Docs
site_name: Browsertrix Docs
repo_url: https://github.com/webrecorder/browsertrix-cloud/
repo_name: Browsertrix Cloud
repo_name: Browsertrix
edit_uri: edit/main/docs/
extra_css:
- stylesheets/extra.css
Expand All @@ -23,7 +23,8 @@ theme:
- search.suggest
palette:
scheme: webrecorder
logo: assets/brand/btrix-logo.svg
logo: assets/brand/browsertrix-icon-white.svg
favicon: assets/brand/favicon.svg

icon:
admonition:
Expand Down

0 comments on commit fa194c3

Please sign in to comment.