mkdocs.yml

site_name: "cpp-linter"
site_description: "clang-format and clang-tidy for C and C++, in pull requests, pre-commit hooks and CI."
site_url: "https://cpp-linter.github.io/"
repo_url: https://github.com/cpp-linter
repo_name: "cpp-linter"
copyright: "© 2021-2026, cpp-linter"
# Theme overrides and build requirements live in docs/ but are not pages.
exclude_docs: |
  overrides/
  requirements.txt

nav:
  - Home: index.md
  - Get started: getting-started.md
  - Why cpp-linter: why-cpp-linter.md
  - Showcase: showcase.md
  - Blog:
      - blog/index.md
  - Community: discussion.md
  - Sponsor: sponsor.md

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
    - navigation.indexes
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - search.share
    - toc.follow
  # Fonts load in docs/overrides/main.html.
  font: false
  logo: static/logo.png
  favicon: static/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: cyan
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/lightbulb
        name: Switch to system preference


markdown_extensions:
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      linenums_style: pymdownx-inline
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - toc:
      permalink: true

plugins:
  - search
  - tags
  - blog:
      blog_dir: blog
      post_excerpt: required
      post_readtime: true
      categories_allowed:
        - Guides
        - Releases
        - Announcements

extra_css:
  - stylesheets/shared.css
  - stylesheets/extra.css

edit_uri_template: https://github.com/cpp-linter/cpp-linter.github.io/edit/main/docs/{path}

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cpp-linter
      name: cpp-linter on GitHub
    - icon: material/forum
      link: https://github.com/cpp-linter/cpp-linter/discussions
      name: GitHub Discussions
    - icon: simple/opencollective
      link: https://opencollective.com/cpp-linter
      name: Sponsor on Open Collective
  analytics:
    provider: google
    property: G-JKH4SXC7HC
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            <a href="https://github.com/cpp-linter/cpp-linter.github.io/issues/new?title=Feedback:+{title}&body=Page:+{url}" target="_blank" rel="noopener">opening an issue</a>.