Files
sunnypilot/mkdocs-sp.yml
T
2024-08-07 15:15:49 -04:00

104 lines
2.8 KiB
YAML

site_name: sunnypilot docs
repo_name: sunnypilot/sunnypilot
repo_url: https://github.com/sunnypilot/sunnypilot/
site_description: sunnypilot Documentation
site_url: https://docs.sunnypilot.ai
edit_uri: blob/new-docs/docs_sp
exclude_docs: README.md
strict: true
docs_dir: docs_sp
site_dir: docs_sp_site/
theme:
name: material
icon:
repo: fontawesome/brands/github
edit: material/lead-pencil
view: material/eye
features:
- content.action.edit
- content.code.copy
- content.code.select
#- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
font:
text: Roboto
code: Roboto Mono
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
navigation_depth: 3
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true
nav:
- Getting Started:
- What is sunnypilot?: getting-started/what-is-sunnypilot.md
- Use sunnypilot in a car: getting-started/use-sunnypilot-in-a-car.md
- Develop sunnypilot: getting-started/develop-sunnypilot.md
- Setup:
- 🚨 Read before installing 🚨: setup/read-before-installing.md
- Installation:
- URL Method: setup/url-method.md
- SSH Method: setup/ssh-method.md
- Changelogs:
- setup/changelogs/index.md
- Features:
- Modified Assistive Driving Safety (MADS): features/modified-assistive-driving-safety.md
- Dynamic Lane Profile (DLP): features/dynamic-lane-profile.md
- Community:
- Contributing: community/CONTRIBUTING.md
- Reporting a bug: community/reporting-a-bug.md
- Safety Information:
- Safety: SAFETY.md
- Prohibited safety modifications: safety-information/prohibited-safety-modifications.md
- How To:
- Enable Mapbox navigation: how-to/enable-mapbox-navigation.md
- Enable Radar Tracks: how-to/radar-tracks.md
- Turn the speed blue: how-to/turn-the-speed-blue.md
- References:
- Branches:
- Definitions: branches/definitions.md
- Recommended Branches: branches/recommended-branches.md