mkdocs-base.yml

# MkDocs configuration for Netlify builds

site_name: Percona XtraDB Cluster
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/pxc-docs
repo_url: https://github.com/percona/pxc-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
    - search.share
    - search.suggest
    - navigation.top
    - navigation.tracking 
    - navigation.instant
    - navigation.instant.progress
    - navigation.indexes
    - content.tooltips
    - content.tabs.link
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - toc.follow 

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 }}'

  mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: null
  print-site:
    add_to_navigation: false
    print_page_title: 'Percona XtraDB Cluster documentation'
    add_print_site_banner: false
    # Table of contents
    add_table_of_contents: true
    toc_title: 'Table of Contents'
    toc_depth: 2
    # Content-related
    add_full_urls: false
    enumerate_headings: false
    enumerate_headings_depth: 1
    enumerate_figures: true
    add_cover_page: true
    cover_page_template: "docs/templates/pdf_cover_page.tpl"
    path_to_pdf: ""
    include_css: true
    enabled: true
    
extra:
  version: 
    provider: mike

nav:
  - Home: index.md
  - Percona XtraDB Cluster PRO:
      - pxc-pro.md
      - Install Percona XtraDB Cluster Pro:
        - install-pro.md
        - pro-files.md
      - Pro build features:
        - fips.md
  - get-help.md
  - Release notes:
      - Release notes index: release-notes/release-notes_index.md
      - release-notes/8.0.41-32.md
      - release-notes/8.0.40-31.md
      - release-notes/8.0.39-30.md
      - release-notes/8.0.38.md
      - release-notes/8.0.37-29.md
      - release-notes/8.0.36-28.md
      - release-notes/8.0.35-27.md
      - release-notes/8.0.34-26.md
      - release-notes/8.0.33-25.upd.md
      - release-notes/8.0.33-25.md
      - release-notes/8.0.32-24.2.md
      - release-notes/8.0.32-24.md
      - release-notes/8.0.31-23.2.md
      - release-notes/8.0.31-23.md
      - release-notes/8.0.30-22.md
      - release-notes/8.0.29-21.md
      - release-notes/Percona-XtraDB-Cluster-8.0.28-19.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.27-18.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.26-16.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.25-15.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.23-14.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.22-13.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.21-12.1.md
      - release-notes/Percona-XtraDB-Cluster-8.0.20-11.md
      - release-notes/Percona-XtraDB-Cluster-8.0.20-11.3.md
      - release-notes/Percona-XtraDB-Cluster-8.0.20-11.2.md
      - release-notes/Percona-XtraDB-Cluster-8.0.19-10.md
      - release-notes/Percona-XtraDB-Cluster-8.0.18-9.3.md
  - Introduction:
      - intro.md
      - limitation.md
      
  - Features:
      - high-availability.md
      - strict-mode.md

  - Quickstart guide:
      - quickstart-overview.md
      - get-started-cluster.md
  - Get started:
      - install-index.md
      - download-instructions.md
      - apt.md 
      - yum.md 
      - tarball.md
      - compile.md
      - docker.md 
      - configure-nodes.md
      - bootstrap.md
      - add-node.md
      - verify-replication.md
      - Troubleshoot install: 
          - timeoutstarts.md

  - Upgrade:
      - upgrade-guide.md
      - upgrade-from-backup.md
  - PXC security:
      - security-index.md
      - secure-network.md
      - encrypt-traffic.md
      - apparmor.md
      - selinux.md
  - User's manual:
      - Solid State Transfer:
        - state-snapshot-transfer.md
        - xtrabackup-sst.md
        - clone-sst.md
      - restarting-nodes.md
      - failover.md
      - monitoring.md
      - certification.md
      - threading-model.md
      - gcache-record-set-cache-difference.md
      - gcache-write-set-cache-encryption.md
      - performance-schema-instrumentation.md
      - data-at-rest-encryption.md
  - How-tos:
      - crash-recovery.md
      - configure-cluster-rhel.md
      - configure-cluster-ubuntu.md
      - garbd-howto.md
      - haproxy.md
      - haproxy-config.md
      - load-balance-proxysql.md
      - Online schema upgrade:
        - online-schema-upgrade.md
        - nbo.md
        - rsu.md
        - toi.md
      - proxysql-v2.md
      - singlebox.md
      - set-up-3nodes-ec2.md
      - virtual-sandbox.md

  - Reference:
      - wsrep-status-index.md
      - wsrep-system-index.md
      - wsrep-provider-index.md
      - wsrep-files-index.md
      - telemetry.md
      - xtradb-cluster-version-numbers.md
      - faq.md
      - glossary.md
      - copyright-and-licensing-information.md
      - trademark-policy.md
  - Topic Index: index-contents.md

# - Version Selector: "../"