mkdocs-base.yml

# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: PMM Dump
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: Percona LLC and/or its affiliates, © 2009 - 2023
use_directory_urls: false
repo_name: percona/pmm_dump_docs
repo_url: https://github.com/percona/pmm_dump_docs
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: _resource/overrides
  logo: assets/pmm-mark.svg
  favicon: assets/pmm-fav.svg
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    edit: material/file-edit-outline
    view: material/file-eye-outline

  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
  
  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/lightgallery.min.css
  - css/extra.css
  - css/nocopy.css
  - css/design.css
  - css/osano.css
  - css/pmm.css

extra_javascript:
  - js/promptremover.js
#  - js/version-select.js
  - js/toctree.js
  - js/lightgallery.min.js
  - js/consent.js


markdown_extensions:
  attr_list: {}
  toc:
    permalink: true
    title: On this page
    toc_depth: 3
  md_in_html: {}
  admonition: {}
  footnotes: {}
  def_list: {} # https://michelf.ca/projects/php-markdown/extra/#def-list
  meta: {}
  md_in_html: {}
  smarty:
      {smart_angled_quotes: true}
  pymdownx.details: {}
  pymdownx.mark: {}
  pymdownx.smartsymbols: {}
  pymdownx.tabbed: 
      {alternate_style: true}
  pymdownx.tilde: {}
  pymdownx.superfences: {}
  pymdownx.tabbed:
    alternate_style: true
  pymdownx.tasklist:
    custom_checkbox: true
  pymdownx.snippets:
      base_path: ["snippets"]
      auto_append:
        - services-banner.md
  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/overrides/.icons

plugins:
  search: {}
  git-revision-date-localized: {}
  meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
  macros:
    include_yaml:
      - "variables.yml"
  # https://pypi.org/project/mkdocs-exclude/
  exclude:
    glob:
      - "setting-up/client/docker.md"
  # https://github.com/orzih/mkdocs-with-pdf
  with-pdf:
    output_path: "_pdf/PMMDump.pdf"
    cover_title: "Documentation"
    cover_subtitle: 0.6.2-rc (March 8, 2023)
    author: "Percona Technical Documentation Team"
    cover_logo: docs/assets/images/pmm_dump-logo.png
    custom_template_path: _resources/templates
    enabled_if_env: ENABLE_PDF_EXPORT
  # Check links - but extends build time significantly
  # https://pypi.org/project/mkdocs-htmlproofer-plugin/
  #    htmlproofer: {}
  mike:
    version_selector: true
    css_dir: css
    javascript_dir: js
    canonical_version: null

extra: # Used in main.html template and can't be externalized
#  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
#   updated_text: '<i class="uil uil-refresh"></i> Page updated'
  release: 0.6.2-rc
  pmm2recommended: 2.35.0
  version:
    provider: mike

# Common navigation for percona.com, render.com and PDF
nav:

    - Welcome: index.md
    - Getting started:
          - "System requirements": "requirements.md"
          - "Installation": installation.md
          - "Usage": usage.md
          
    - Export metrics: 
          - "Overview": export.md
          - "Exporting Query Analytics Data": export_qan.md
          - "Exporting specific time range": export_time_range.md
          - "Exporting metrics for a specific database instance": export_instance.md
          - "Exporting metrics for a specific dashboard": export_dashboard.md
          - "Advanced filtering": export_advanced_filtering.md 
          
    - Import metrics: 
          - "Overview": import.md

    - Helper scripts:
          - "load-pmm-dump": load-pmm-dump.md
          - "verify-vm-native-data": verify-vm-native-data.md

    - Reference:
          - "Commands": commands.md
          - "Options and variables": options.md
          - "Known issues": known-issues.md
          - "Troubleshooting": troubleshooting.md
          - "Frequently Asked Questions": faq.md

    - Contributing:
          - "Contributing": contributing.md
          - "Testing": testing.md

    - Release Notes:
          - "Release notes index": ReleaseNotes/index.md
          - "PMM Dump 0.7.0-ga (2023-11-22)": ReleaseNotes/PMM-Dump-0.7.0-ga.md
          - "PMM Dump 0.6.4-rc (2023-06-30)": ReleaseNotes/PMM-Dump-0.6.4-rc.md
          - "PMM Dump 0.6.3-rc (2023-05-04)": ReleaseNotes/PMM-Dump-0.6.3-rc.md
          - "PMM Dump 0.6.2-rc (2023-03-08)": ReleaseNotes/PMM-Dump-0.6.2-rc.md
          - "PMM Dump 0.6.1-rc (2022-07-01)": ReleaseNotes/PMM-Dump-0.6.1-rc.md