mkdocs.yml

site_name: "DevView"
site_description: "A Kotlin Multiplatform developer tools framework for Android and iOS"
site_author: "Maxime Michel"
site_url: "https://worldline.github.io/devview/"
edit_uri: "tree/main/docs/"
remote_branch: gh-pages
strict: true

docs_dir: docs

repo_name: "DevView"
repo_url: "https://github.com/worldline/devview"

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
      - Configuration: getting-started/configuration.md
  - Modules:
      - modules/index.md
      - Core Module: modules/core.md
      - FeatureFlip: modules/featureflip.md
      - Analytics: modules/analytics.md
      - Creating Custom Modules: modules/custom-modules.md
  - Guides:
      - guides/index.md
      - Integration Guide: guides/integration.md
      - Module Development: guides/module-development.md
      - Navigation: guides/navigation.md
      - Theming: guides/theming.md
      - Best Practices: guides/best-practices.md
  - API Reference:
      - api/index.md
      - Core API: api/core.md
      - FeatureFlip API: api/featureflip.md
      - Analytics API: api/analytics.md
  - Examples:
      - examples/index.md
      - Android Setup: examples/android.md
      - iOS Setup: examples/ios.md
      - Feature Flags: examples/feature-flags.md
      - Analytics Tracking: examples/analytics-tracking.md
  - Contributing:
      - contributing/index.md
      - Development Setup: contributing/development.md
      - Code Style: contributing/code-style.md
      - Pull Requests: contributing/pull-requests.md
  - Changelog: changelog.md
  - License: license.md

copyright: "Copyright © 2026 Maxime Michel"

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
    logo: material/developer-board
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: light-green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: light-green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

plugins:
  - mike
  - social
  - search
  - tags

markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - footnotes
  - toc:
      permalink: true
  - pymdownx.betterem
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - mdx_gh_links:
      user: "worldline"
      repo: "devview"
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - md_in_html
  - def_list
  - tables

extra:
  versions:
    devview: !ENV [DEVVIEW_VERSION, "local-development"]
  version:
    provider: mike
    alias: true

validation:
  unrecognized_links: warn
  anchors: warn