72d1529993
Quick fix for some 404 links on the docs site. UI documentation has been moved to storybook in https://github.com/webrecorder/browsertrix/pull/2597, but links to these pages in the docs sidebar wasn't removed in that PR.
149 lines
4.1 KiB
YAML
149 lines
4.1 KiB
YAML
site_name: Browsertrix Docs
|
|
repo_url: https://github.com/webrecorder/browsertrix-cloud/
|
|
repo_name: Browsertrix
|
|
edit_uri: edit/main/frontend/docs/docs/
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
extra_javascript:
|
|
- js/insertversion.js
|
|
- js/embed.js
|
|
theme:
|
|
name: material
|
|
custom_dir: docs/overrides
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.footer
|
|
- content.code.copy
|
|
- content.action.edit
|
|
- content.tooltips
|
|
- search.suggest
|
|
palette:
|
|
scheme: webrecorder
|
|
logo: assets/brand/browsertrix-icon-white.svg
|
|
favicon: assets/brand/favicon.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-diamond-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:
|
|
- Overview: index.md
|
|
- User Guide:
|
|
- user-guide/index.md
|
|
- Getting Started:
|
|
- user-guide/signup.md
|
|
- user-guide/getting-started.md
|
|
- Orgs:
|
|
- user-guide/org.md
|
|
- user-guide/join.md
|
|
- user-guide/overview.md
|
|
- Crawling:
|
|
- user-guide/crawl-workflows.md
|
|
- user-guide/workflow-setup.md
|
|
- user-guide/running-crawl.md
|
|
- Archived Items:
|
|
- user-guide/archived-items.md
|
|
- user-guide/review.md
|
|
- Collections:
|
|
- user-guide/collection.md
|
|
- user-guide/public-collections-gallery.md
|
|
- user-guide/presentation-sharing.md
|
|
- Quality Assurance:
|
|
- user-guide/quality-assurance.md
|
|
- user-guide/qa-review.md
|
|
- Browser Profiles:
|
|
- user-guide/browser-profiles.md
|
|
- Org Settings:
|
|
- user-guide/org-settings.md
|
|
- user-guide/org-members.md
|
|
- Account Settings:
|
|
- user-guide/user-settings.md
|
|
- user-guide/contribute.md
|
|
- Self-Hosting:
|
|
- Overview: deploy/index.md
|
|
- deploy/local.md
|
|
- deploy/remote.md
|
|
- deploy/customization.md
|
|
- deploy/proxies.md
|
|
- Ansible:
|
|
- deploy/ansible/digitalocean.md
|
|
- deploy/ansible/microk8s.md
|
|
- deploy/ansible/k3s.md
|
|
- Administration:
|
|
- deploy/admin/upgrade-notes.md
|
|
- deploy/admin/org-import-export.md
|
|
- Development:
|
|
- develop/index.md
|
|
- develop/local-dev-setup.md
|
|
- develop/docs.md
|
|
- UI Development:
|
|
- develop/frontend-dev.md
|
|
- develop/ui/components.md
|
|
- develop/ui/storybook.md
|
|
- develop/localization.md
|
|
|
|
- API Reference: !ENV [ API_DOCS_URL, "/api/" ]
|
|
|
|
|
|
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.tabbed:
|
|
alternate_style: true
|
|
- 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
|
|
analytics:
|
|
provider: plausible
|
|
enable_analytics: !ENV ENABLE_ANALYTICS
|
|
copyright: "Creative Commons Attribution 4.0 International (CC BY 4.0)"
|
|
|
|
plugins:
|
|
- search
|
|
- redirects:
|
|
redirect_maps:
|
|
"user-guide/collections.md": "user-guide/collection.md"
|