site_name: Ktlint
site_url: https://pinterest.github.io/ktlint/

site_dir: build/site
docs_dir: docs

extra:
  version:
    provider: mike

theme:
  name: material
  custom_dir: overrides
  favicon: assets/images/favicon.ico
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: material/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.share
    - content.code.copy

nav:
  - Home:
      - Features: index.md
      - Quick start: quick-start.md
  - Installation:
    - Recommended setup: install/setup.md
    - Command line: install/cli.md
    - Integrations: install/integrations.md
#    - API: install/api.md  TODO: properly document
    - Snapshot build: install/snapshot-build.md
  - Rules:
    - Code styles: rules/code-styles.md
    - Standard rules: rules/standard.md
    - Experimental rules: rules/experimental.md
    - Dependencies: rules/dependencies.md
    - KtLint configuration: rules/configuration-ktlint.md
    - IntelliJ IDEA configuration: rules/configuration-intellij-idea.md
  - API:
      - Overview: api/overview.md
      - Custom integration: api/custom-integration.md
      - Custom rule set: api/custom-rule-set.md
      - Custom reporter: api/custom-reporter.md
      - Badge: api/badge.md
  - FAQ: faq.md
  - Contributing:
      - Overview: contributing/overview.md
      - Guidelines: contributing/guidelines.md
      - Code of conduct: contributing/code-of-conduct.md

plugins:
  - search

repo_url: https://github.com/pinterest/ktlint
repo_name: pinterest/ktlint

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - attr_list
  - md_in_html
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true