05c5e09d25
Closes #1434 ### Changes #### Developer - Adds the K3S playbook guide to the navigation - Adds note about restarting MKDocs when adding new icons - Adds note about concise language to the styleguide ([see previous discussion](https://github.com/webrecorder/browsertrix-cloud/pull/1394#discussion_r1402666872)) - Adds a note about noun usage to the styleguide #### User guide - Adds tables for archived item and workflow statuses - Adds custom styles for displaying statuses with their icons like we do in the app - Fixes capitalization issues --------- Co-authored-by: Tessa Walsh <tessa@bitarchivist.net> Co-authored-by: sua yoo <sua@webrecorder.org>
105 lines
2.8 KiB
YAML
105 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
|
|
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:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.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)"
|