mkdocs.template.yml

site_name: Ruff
theme:
  name: material
  logo: assets/bolt.svg
  favicon: assets/favicon.ico
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - content.code.annotate
    - toc.integrate
    - toc.follow
    - navigation.path
    - navigation.top
    - content.code.copy
    - content.tabs.link
  palette:
    # Note: Using the system theme works with the insiders version
    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: astral-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: astral-dark
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  custom_dir: docs/.overrides
repo_url: https://github.com/astral-sh/ruff
repo_name: ruff
site_author: charliermarsh
site_url: https://docs.astral.sh/ruff/
site_dir: site/ruff
site_description: An extremely fast Python linter and code formatter, written in Rust.
markdown_extensions:
  - admonition
  - pymdownx.details
  - toc:
      anchorlink: true
      anchorlink_class: "toclink"
  - pymdownx.snippets:
  - pymdownx.magiclink:
  - attr_list:
  - md_in_html:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - markdown.extensions.attr_list:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true
plugins:
  - search
  - gh-admonitions
  - llmstxt:
      markdown_description: |
        Ruff is an extremely fast Python linter and code formatter, written in Rust.
        It can be used to replace Flake8 (plus dozens of plugins), Black, isort, pydocstyle,
        pyupgrade, autoflake, and more, all while executing tens or hundreds of times faster
        than any individual tool.

        Ruff includes both a linter (`ruff check`) and a formatter (`ruff format`).

        When fetching documentation, use explicit `index.md` paths for directories, e.g.,
        `https://docs.astral.sh/ruff/editors/index.md`. This returns clean markdown instead
        of rendered HTML with JS/CSS.
      sections:
        Getting started:
          - installation.md
          - tutorial.md
        Configuration:
          - configuration.md
        Linter:
          - linter.md
        Formatter:
          - formatter.md
          - formatter/black.md
        Editors:
          - editors/index.md
          - editors/setup.md
          - editors/settings.md
          - editors/features.md
          - editors/migration.md
        Integrations:
          - integrations.md
        Concepts:
          - preview.md
          - versioning.md
        Reference:
          - faq.md
extra_css:
  - stylesheets/extra.css
  - stylesheets/rule-filters.css
extra_javascript:
  - js/extra.js
  - js/rule-filters.js
not_in_nav: |
  /rules/*
  /formatter/*
extra:
  analytics:
    provider: fathom
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/astral-sh/ruff
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/astral-sh
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ruff/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/astral_sh
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn