b2d526f09a
Fixes #1463 ### Changes - Explains execution time - Adds style guide section about adding a badge for paid features - Updates config for mkdocs-material 9.5, materialx emoji support is being removed. - Adds better tooltips, a cool feature that also got released with mkdocs-material 9.5 - Adds search suggestions ### Caveats - [mkdocs 1.5 has improved the way they handle link validation](https://www.mkdocs.org/about/release-notes/#expanded-validation-of-links). Looks like way I've gone about linking things could be improved, and it will give a bunch of warnings as a result. The site still builds fine, but I'm going to fix this in a different PR so this one doesn't take as much effort to review :) EDIT: Here's that PR https://github.com/webrecorder/browsertrix-cloud/pull/1476 ### Testing - Make sure you are up to date with `pip install --upgrade mkdocs-material` ### Screenshot **Badge!** <img width="884" alt="Screenshot 2024-01-17 at 11 59 00 PM" src="https://github.com/webrecorder/browsertrix-cloud/assets/5672810/62a51cf6-24bd-49f1-a6d0-d335f730bfbe"> ### Future - Should mkdocs-material be versioned in our deployment script? We risk things breaking if I don't get to them fast enough! 🙃 --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net>
110 lines
2.8 KiB
YAML
110 lines
2.8 KiB
YAML
site_name: Browsertrix Cloud Docs
|
|
repo_url: https://github.com/webrecorder/browsertrix-cloud/
|
|
repo_name: Browsertrix Cloud
|
|
edit_uri: edit/main/docs/
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
extra_javascript:
|
|
- js/insertversion.js
|
|
theme:
|
|
name: material
|
|
custom_dir: docs/overrides
|
|
features:
|
|
- navigation.sections
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.indexes
|
|
- navigation.footer
|
|
- content.code.copy
|
|
- content.action.edit
|
|
- content.tooltips
|
|
- search.suggest
|
|
palette:
|
|
scheme: webrecorder
|
|
logo: assets/brand/btrix-logo.svg
|
|
|
|
icon:
|
|
admonition:
|
|
note: bootstrap/pencil-fill
|
|
abstract: bootstrap/file-earmark-text-fill
|
|
info: bootstrap/info-circle-fill
|
|
tip: bootstrap/exclamation-circle-fill
|
|
success: bootstrap/check-circle-fill
|
|
question: bootstrap/question-circle-fill
|
|
warning: bootstrap/exclamation-triangle-fill
|
|
failure: bootstrap/x-octagon-fill
|
|
danger: bootstrap/exclamation-diamond-fill
|
|
bug: bootstrap/bug-fill
|
|
example: bootstrap/mortarboard-fill
|
|
quote: bootstrap/quote
|
|
|
|
repo: bootstrap/github
|
|
edit: bootstrap/pencil
|
|
view: bootstrap/eye
|
|
|
|
nav:
|
|
- index.md
|
|
- Deploy:
|
|
- deploy/index.md
|
|
- deploy/local.md
|
|
- deploy/remote.md
|
|
- Ansible:
|
|
- deploy/ansible/digitalocean.md
|
|
- deploy/ansible/microk8s.md
|
|
- deploy/ansible/k3s.md
|
|
- Develop:
|
|
- develop/index.md
|
|
- develop/local-dev-setup.md
|
|
- develop/frontend-dev.md
|
|
- develop/docs.md
|
|
- User Guide:
|
|
- user-guide/index.md
|
|
- user-guide/signup.md
|
|
- Crawling:
|
|
- user-guide/crawl-workflows.md
|
|
- user-guide/workflow-setup.md
|
|
- user-guide/browser-profiles.md
|
|
- user-guide/overview.md
|
|
- user-guide/archived-items.md
|
|
- user-guide/collections.md
|
|
- user-guide/org-settings.md
|
|
- user-guide/user-settings.md
|
|
|
|
markdown_extensions:
|
|
- toc:
|
|
toc_depth: 3
|
|
permalink: true
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
options:
|
|
custom_icons:
|
|
- docs/overrides/.icons
|
|
- admonition
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.keys
|
|
- def_list
|
|
- attr_list
|
|
|
|
extra:
|
|
generator: false
|
|
social:
|
|
- icon: bootstrap/globe
|
|
link: https://webrecorder.net
|
|
- icon: bootstrap/chat-left-text-fill
|
|
link: https://forum.webrecorder.net/
|
|
- icon: bootstrap/mastodon
|
|
link: https://digipres.club/@webrecorder
|
|
- icon: bootstrap/youtube
|
|
link: https://www.youtube.com/@webrecorder
|
|
copyright: "Creative Commons Attribution 4.0 International (CC BY 4.0)"
|
|
|
|
plugins:
|
|
- search
|