mkdocs.yml

site_name: OpenEV Data
site_url: https://open-ev-data.github.io
site_description: The single source of truth for electric vehicle specifications
site_author: OpenEV Data Contributors
repo_url: https://github.com/open-ev-data
repo_name: open-ev-data
edit_uri: ""

copyright: Copyright © 2025 OpenEV Data Contributors

theme:
  name: material
  custom_dir: overrides
  logo: assets/images/open-ev-data-logo.svg
  favicon: assets/images/open-ev-data-logo-mini.png
  palette:
    - scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - announce.dismiss

extra_css:
  - assets/stylesheets/extra.css

extra:
  google_site_verification: fj2Tueuj9hv7V9o5XJh1a3VNQiSncuV9XcWWHU_0grM
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/open-ev-data
      name: OpenEV Data on GitHub
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
  - redirects:
      redirect_maps: {}

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Anchor link to this section for reference
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - About: index.md
  - Getting Started:
      - Overview: getting-started/index.md
      - Quick Start: getting-started/quick-start.md
      - Installation: getting-started/installation.md
  - Project Governance:
      - Overview: governance/index.md
      - Getting Started: governance/GET_STARTED.md
      - Contributing: governance/CONTRIBUTING.md
      - Code of Conduct: governance/CODE_OF_CONDUCT.md
  - API Documentation:
      - Overview: api/index.md
      - Get Started: api/GET_STARTED.md
      - Architecture: api/ARCHITECTURE.md
      - Testing: api/TESTING.md
      - Rust Guidelines: api/RUST_GUIDELINES.md
      - Release Strategy: api/RELEASE_STRATEGY.md
      - API Errors: api/API_ERRORS.md
      - Problem Details RFC: api/PROBLEM_DETAILS_RFC_7807.md
      - Crates:
          - ev-core: api/CRATE_EV_CORE.md
          - ev-etl: api/CRATE_EV_ETL.md
          - ev-server: api/CRATE_EV_SERVER.md
  - Dataset Documentation:
      - Overview: dataset/index.md
      - How to Consume: dataset/HOW_TO_CONSUME.md
      - Architecture: dataset/ARCHITECTURE.md
      - Schema Reference: dataset/SCHEMA.md
      - Contributing Vehicles: dataset/CONTRIBUTING_VEHICLES.md
      - Release Process: dataset/RELEASE_PROCESS.md
  - UI Documentation:
      - Overview: ui/index.md
      - Architecture: ui/ARCHITECTURE.md
      - Design System: ui/DESIGN_SYSTEM.md
      - Components: ui/UI_COMPONENTS.md
      - Page Layouts: ui/PAGE_LAYOUTS.md
      - Responsive Strategy: ui/RESPONSIVE_STRATEGY.md
      - SEO Strategy: ui/SEO_STRATEGY.md
  - Changelog:
      - API Changelog: changelog-api.md
      - Dataset Changelog: changelog-dataset.md
      - UI Changelog: changelog-ui.md
  - Guides:
      - Contributing: guides/contributing.md