mkdocs-base.yml

# MkDocs configuration for builds with material theme

site_name: Percona Distribution for MySQL 
site_description: Documentation
site_author: Percona LLC
copyright: >-
  <a href="https://www.percona.com/about">Percona LLC</a> and its affiliates #&copy; 2024 — <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-#dialog-open')">Cookie Preferences</a>
repo_name: /percona/pdmysql-docs
repo_url: https://github.com/percona/pdmysql-docs
edit_uri: edit/8.0/docs/

use_directory_urls: false

# Theme setup
theme:
  name: material
  logo: assets/mysql-mark.svg
  favicon: assets/mysql-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

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

#Styling
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/design.css
  - css/osano.css
  - css/extra.css
  - css/nocopy.css
  - css/mysql.css

extra_javascript:
  - js/version-select.js
  - js/promptremover.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/.icons
  
plugins:
  search: 
    separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  git-revision-date: {}
  meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
  macros:
      include_yaml:
        - 'variables.yml' # Use in markdown as '{{ VAR }}'
# exclude: # Don't process these files
#      glob:
#         - file.md
  with-pdf: # https://github.com/orzih/mkdocs-with-pdf
          output_path: '_pdf/PerconaDistributionforMySQL.pdf'
          cover_title: 'Percona Distribution for MySQL Documentation'
          cover_subtitle: 8.0.39 (2024-10-08)
          author: 'Percona Technical Documentation Team'
          cover_logo: docs/_images/pdf-logo.png
          debug_html: false
          custom_template_path: _resource/templates
          enabled_if_env: ENABLE_PDF_EXPORT
         
  mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: null

extra:
  version:
    provider: mike
  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
  updated_text: '<i class="uil uil-refresh"></i> Page updated'

nav:
  - Home: index.md
  - Release notes:
    - Release notes index: release-notes.md
    - Percona Distribution for MySQL using Percona Server for MySQL:
      - release-notes-ps-v8.0.39.md
      - release-notes-ps-v8.0.38.md
      - release-notes-ps-v8.0.37.md
      - release-notes-ps-v8.0.36.md
      - release-notes-ps-v8.0.35.md
      - release-notes-ps-v8.0.34.upd3.md
      - release-notes-ps-v8.0.34.upd2.md
      - release-notes-ps-v8.0.34.upd.md
      - release-notes-ps-v8.0.34.md
      - release-notes-ps-v8.0.33.upd3.md
      - release-notes-ps-v8.0.33.upd2.md
      - release-notes-ps-v8.0.33.upd.md
      - release-notes-ps-v8.0.33.md
      - release-notes-ps-v8.0.32.upd3.md
      - release-notes-ps-v8.0.32.upd2.md
      - release-notes-ps-v8.0.32.upd.md
      - release-notes-ps-v8.0.32.md
      - release-notes-ps-v8.0.31.upd.md
      - release-notes-ps-v8.0.31.md
      - release-notes-ps-v8.0.30.upd2.md
      - release-notes-ps-v8.0.30.upd.md
      - release-notes-ps-v8.0.30.md
      - release-notes-ps-v8.0.29.md
      - release-notes-ps-v8.0.28.upd.md
      - release-notes-ps-v8.0.28.md
      - release-notes-ps-v8.0.27.md
      - release-notes-ps-v8.0.26.md
      - release-notes-ps-v8.0.25.md
      - release-notes-ps-v8.0.23.md
      - release-notes-ps-v8.0.22.md
      - release-notes-ps-v8.0.21.md
      - release-notes-ps-v8.0.20.md
      - release-notes-v8.0.19.md
    - Percona Distribution for MySQL using Percona XtraDB Cluster:
      - release-notes-pxc-v8.0.37.md
      - release-notes-pxc-v8.0.36.md
      - release-notes-pxc-v8.0.35.md
      - release-notes-pxc-v8.0.34.upd2.md
      - release-notes-pxc-v8.0.34.upd.md
      - release-notes-pxc-v8.0.34.md
      - release-notes-pxc-v8.0.33.upd.md
      - release-notes-pxc-v8.0.33.md
      - release-notes-pxc-v8.0.32.upd3.md
      - release-notes-pxc-v8.0.32.upd2.md
      - release-notes-pxc-v8.0.32.upd.md
      - release-notes-pxc-v8.0.32.md
      - release-notes-pxc-v8.0.31.upd2.md
      - release-notes-pxc-v8.0.31.upd.md
      - release-notes-pxc-v8.0.31.md
      - release-notes-pxc-v8.0.30.upd.md
      - release-notes-pxc-v8.0.30.md
      - release-notes-pxc-v8.0.29.upd.md
      - release-notes-pxc-v8.0.29.md
      - release-notes-pxc-v8.0.28.md
      - release-notes-pxc-v8.0.27.md  
      - release-notes-pxc-v8.0.26.md   
      - release-notes-pxc-v8.0.25.md 
      - release-notes-pxc-v8.0.23.upd.md
      - release-notes-pxc-v8.0.23.md
      - release-notes-pxc-v8.0.22.md
      - release-notes-pxc-v8.0.21.md
      - release-notes-pxc-v8.0.20.upd2.md
      - release-notes-pxc-v8.0.20.upd.md
      - release-notes-pxc-v8.0.20.md
      - release-notes-v8.0.19.md  
  - Discover Percona Distribution for MySQL:
    - components.md
    - deployment-variants.md
  - Install and update:
    - installing.md
    - minor-upgrade.md
    - downgrade.md
  - Solutions - high availability:
    - Technical overview: solutions/pdps-group-replication.md
    - solutions/architecture-components.md
    - solutions/monitoring.md
    - Deployment: solutions/deploy-pdps-group-replication.md
  - Replication manager for Percona XtraDB Cluster:
    - replication-manager/replication-manager-for-pxc.md
    - replication-manager/replication-manager-troubleshooting.md
    - replication-manager/single-replica-manager.md
  - Uninstall:
    - uninstalling.md
  - Copyright and licensing: copyright.md
  - Trademark policy: trademark-policy.md  
  - Glossary: glossary.md