sunnypilot/zensical.toml

[project]
site_name = "sunnypilot docs"
site_url = "https://docs.sunnypilot.ai"
site_description = "sunnypilot Documentation"
repo_name = "sunnypilot/sunnypilot"
repo_url = "https://github.com/sunnypilot/sunnypilot/"
edit_uri = "blob/docs/docs_sp"
docs_dir = "docs_sp"
site_dir = "docs_site_sp"
strict = true
exclude_docs = "README.md"
extra_css = ["stylesheets/style.css"]

nav = [
  { "Home" = "index.md" },
  { "Getting Started" = [
    "getting-started/index.md",
    { "What is sunnypilot?" = "getting-started/what-is-sunnypilot.md" },
    { "Use sunnypilot in a car" = "getting-started/use-sunnypilot-in-a-car.md" },
  ]},
  { "Installation" = [
    "setup/index.md",
    { "Read Before Installing" = "setup/read-before-installing.md" },
    { "URL Method" = "setup/url-method.md" },
    { "SSH Method" = "setup/ssh-method.md" },
  ]},
  { "Features" = [
    "features/index.md",
    { "Cruise Control" = [
      "features/cruise/index.md",
      { "Intelligent Cruise Button Management" = "features/cruise/icbm.md" },
      { "Smart Cruise Control - Vision" = "features/cruise/scc-v.md" },
      { "Smart Cruise Control - Map" = "features/cruise/scc-m.md" },
      { "Custom ACC Increments" = "features/cruise/custom-acc-increments.md" },
      { "Dynamic Experimental Control" = "features/cruise/dynamic-experimental-control.md" },
      { "Speed Limit Assist" = "features/cruise/speed-limit.md" },
      { "Alpha Longitudinal" = "features/cruise/alpha-longitudinal.md" },
    ]},
    { "Steering" = [
      "features/steering/index.md",
      { "Modular Assistive Driving System" = "features/steering/mads.md" },
      { "Neural Network Lateral Control" = "features/steering/nnlc.md" },
      { "Auto Lane Change" = "features/steering/auto-lane-change.md" },
      { "Torque Control" = "features/steering/torque-control.md" },
      { "Blinker Pause Lateral" = "features/steering/blinker-pause.md" },
    ]},
    { "Display & Visuals" = [
      "features/display/index.md",
      { "Onroad Display" = "features/display/onroad-display.md" },
      { "HUD & Visuals" = "features/display/hud-visuals.md" },
    ]},
    { "Models & AI" = "features/models.md" },
    { "Connected Services" = [
      "features/connected/index.md",
      { "sunnylink" = "features/connected/sunnylink.md" },
      { "OSM Maps" = "features/connected/osm-maps.md" },
    ]},
  ]},
  { "Settings" = [
    "settings/index.md",
    { "Platform Differences" = "settings/platform-differences.md" },
    { "Device" = "settings/device.md" },
    { "Network" = "settings/network.md" },
    { "sunnylink" = "settings/sunnylink.md" },
    { "Toggles" = "settings/toggles.md" },
    { "Software" = "settings/software.md" },
    { "Models" = "settings/models.md" },
    { "Steering" = [
      "settings/steering/index.md",
      { "MADS" = "settings/steering/mads.md" },
      { "Lane Change" = "settings/steering/lane-change.md" },
      { "Torque" = "settings/steering/torque.md" },
    ]},
    { "Cruise" = [
      "settings/cruise/index.md",
      { "Speed Limit" = [
        "settings/cruise/speed-limit/index.md",
        { "Speed Limit Source" = "settings/cruise/speed-limit/source.md" },
      ]},
    ]},
    { "Visuals" = "settings/visuals.md" },
    { "Display" = "settings/display.md" },
    { "OSM" = "settings/osm.md" },
    { "Trips" = "settings/trips.md" },
    { "Vehicle" = [
      "settings/vehicle/index.md",
      { "Tesla" = "settings/vehicle/tesla.md" },
      { "Toyota / Lexus" = "settings/vehicle/toyota.md" },
      { "Hyundai / Kia / Genesis" = "settings/vehicle/hyundai.md" },
      { "Subaru" = "settings/vehicle/subaru.md" },
    ]},
    { "Firehose" = "settings/firehose.md" },
    { "Developer" = "settings/developer.md" },
  ]},
  { "How-To Guides" = [
    "how-to/index.md",
    { "Share a Route" = "how-to/share-a-route.md" },
    { "Preserve Local File Changes" = "how-to/preserve-local-changes.md" },
  ]},
  { "Safety" = [
    "safety/index.md",
    { "Safety Information" = "safety/safety.md" },
    { "Driver Responsibility & L2 ADAS" = "safety/driver-responsibility.md" },
    { "Prohibited Modifications" = "safety/prohibited-modifications.md" },
  ]},
  { "Technical Reference" = [
    "technical/index.md",
    { "Hyundai Longitudinal Tuning" = "technical/hyundai-longitudinal-tuning.md" },
    { "Recommended Branches" = "references/recommended-branches.md" },
    { "Branch Definitions" = "references/branch-definitions.md" },
  ]},
  { "Community" = [
    "community/index.md",
    { "Contributing" = "community/contributing.md" },
    { "Workflow" = "community/workflow.md" },
    { "Reporting a Bug" = "community/reporting-a-bug.md" },
    { "Community Forum" = "https://community.sunnypilot.ai" },
  ]},
]

[project.theme]
variant = "modern"
logo = "assets/logo.png"
favicon = "assets/favicon.png"
features = [
  "content.code.copy",
  "content.tabs.link",
  "navigation.tabs",
  "navigation.tabs.sticky",
  "navigation.indexes",
  "navigation.path",
  "navigation.instant",
  "navigation.instant.progress",
  "navigation.tracking",
  "navigation.top",
  "navigation.sections",
  "navigation.expand",
  "navigation.footer",
  "toc.follow",
  "search.suggest",
  "search.highlight",
]

[project.theme.font]
text = "Open Sans"
code = "Fira Code"

[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "material/brightness-auto"
toggle.name = "Switch to light mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "#594AE2"
accent = "#594AE2"
toggle.icon = "material/brightness-7"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "#594AE2"
accent = "#594AE2"
toggle.icon = "material/brightness-4"
toggle.name = "Switch to system preference"

# Markdown extensions
# When specifying any extensions, defaults are overridden, so we must list all needed extensions.
[project.markdown_extensions.admonition]

[project.markdown_extensions.attr_list]

[project.markdown_extensions.def_list]

[project.markdown_extensions.footnotes]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.toc]
permalink = true

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.pymdownx.magiclink]
normalize_issue_symbols = true
repo_url_shorthand = true
user = "sunnypilot"
repo = "sunnypilot"

[project.markdown_extensions.pymdownx.snippets]

[project.markdown_extensions.pymdownx.superfences]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
clickable_checkbox = true

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/sunnypilot/sunnypilot"

[[project.extra.social]]
icon = "fontawesome/solid/comments"
link = "https://community.sunnypilot.ai"