mkdocs.yml

# MkDocs general configuration

site_name: Percona Query Performance Monitoring for PostgreSQL
site_description: Documentation
site_author: Percona LLC
copyright: >
  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2026 

 
repo_name: percona/pgsm-docs
repo_url: https://github.com/percona/pgsm-docs
edit_uri: edit/main/docs/

use_directory_urls: false

# Theme settings
theme:
  name: material
  logo: _images/postgresql-logo.svg
  favicon: _images/postgresql-fav.svg
  custom_dir: _resource/overrides
  font:
    text: Roboto
    code: Roboto Mono

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Color theme set to Automatic. Click to change
    - media: "(prefers-color-scheme: light)"
      scheme: percona-light
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Color theme set to Light Mode. Click to change
    - media: "(prefers-color-scheme: dark)"
      scheme: percona-dark
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Color theme set to Dark Mode. Click to change

# Theme features

  features:
    - search.share
    - search.highlight
    - content.code.copy
    - content.action.view
#    - content.action.edit
    - content.tabs.link
    - navigation.top
    - navigation.tracking


extra_css:
  - https://unicons.iconscout.com/release/v3.0.3/css/line.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
  - css/percona.css
  - css/extra.css
  - css/design.css
  - css/osano.css
  - css/landing.css
  - css/postgresql.css
  - css/rating.css
  - css/kapa.css

extra_javascript:
  - js/version-select.js
  - js/promptremover.js
  - js/consent.js
  - js/rating.js
  - js/kapa.js

markdown_extensions:
  attr_list: {}
  md_in_html: {}
  toc:
    permalink: True
  admonition: {}
  footnotes: {}
  def_list: {}   # https://michelf.ca/projects/php-markdown/extra/#def-list
  meta: {}
  smarty:
    smart_angled_quotes: true
  pymdownx.mark: {}
  pymdownx.smartsymbols: {}
  pymdownx.tilde: {}
  pymdownx.tabbed:
    alternate_style: true
  pymdownx.snippets:  
    base_path: ["snippets"]
#    auto_append:
#     - services-banner.md
  pymdownx.superfences:
    custom_fences:
     - name: mermaid
       class: mermaid
       format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.details: {}
  pymdownx.highlight:
    use_pygments: true
  pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
    options:
      custom_icons:
        - _resource/.icons

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - git-revision-date-localized:
      enable_creation_date: true
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
  - git-committers:
      enabled: !ENV [CI, false]
      repository: percona/pgsm-docs
      branch: "main"
  - meta-descriptions:
      export_csv: false
      quiet: false
      enable_checks: false
      min_length: 50
      max_length: 160
  - section-index # Adds links to nodes - comment out when creating PDF
#  - htmlproofer # Uncomment to check links - but extends build time significantly
  - macros:
      include_yaml:
        - 'variables.yml' # Use in markdown as '{{ VAR }}'   

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-J4J70BNH0G

nav:
  - About: 
    - "Percona Query Performance Monitoring for PostgreSQL": index.md
    - comparison.md
  - get-help.md
  - Get started:
    - "Install": "install.md"
    - "Set up": "setup.md"
  - Usage: "user_guide.md"
  - Configuration: configuration.md
  - Upgrade: upgrade.md
  - pmm.md
  - How to:
    - Auto-create pg_stat_monitor for new databases: auto-enable.md
  - Uninstall: uninstall.md
  - Release notes:
    - Release notes index: release-notes/release_notes.md
    - release-notes/2.4.0.md
    - release-notes/2.3.2.md
    - release-notes/2.3.1.md
    - release-notes/2.2.0.md
    - release-notes/2.1.1.md
    - release-notes/2.1.0.md
    - release-notes/2.0.4.md
    - release-notes/2.0.3.md
    - release-notes/2.0.2.md
    - release-notes/2.0.1.md
    - release-notes/2.0.0.md
    - release-notes/1.x.md
  - Reference:
    - Views: views.md
    - functions.md
    - reference.md
    - copyright.md
    - trademark-policy.md
# - Version Selector: "../"