mkdocs-base.yml

# MkDocs configuration for Netlify builds

site_name: Percona XtraBackup
site_description: Documentation
site_author: Percona LLC
copyright: Percona LLC, © 2022

repo_name: percona/pxb-docs
repo_url: https://github.com/percona/pxb-docs
edit_uri: edit/8.0/docs/

use_directory_urls: false

# Theme setup
theme:
  name: material
  logo: _static/percona-logo.svg
  favicon: _static/percona_favicon.ico
  custom_dir: _resource/overrides/
  font:
    text: Chivo, Colfax, Franziska
  palette:

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: percona-light
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode


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/nocopy.css

extra_javascript:
  - js/version-select.js
  - js/promptremover.js

markdown_extensions:
  attr_list: {}
  toc:
    permalink: True
    title: On this page
    toc_depth: 3
  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.highlight:
      linenums: false
  pymdownx.inlinehilite: {}
  pymdownx.snippets: {}
  pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  search: {}
  git-revision-date: {}
  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/PerconaXtrabackup-8.0.pdf'
          cover_title: 'Percona XtraBackup Documentation'
          cover_subtitle: 8.0.30-23 (November 14, 2022)
          author: 'Percona Technical Documentation Team'
          cover_logo: docs/_static/percona-xtrabackup-logo.jpg
          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

nav:
  - Home: index.md
  - Introduction:
      - intro.md
      - how_xtrabackup_works.md
      - xtrabackup-version-numbers.md
  - Installation:
      - installation.md
      - installation/apt_repo.md
      - installation/yum_repo.md
      - installation/deb-rpm-packages.md
      - installation/binary-tarball.md
      - installation/compiling_xtrabackup.md
      - installation/what-is-in-packages.md
      - installation/uninstall-percona-xtrabackup.md
  - Run in Docker:
      - installation/docker.md
  - How Percona XtraBackup works:
      - xtrabackup_bin/implementation_details.md 
      - using_xtrabackup/privileges.md
      - using_xtrabackup/configuring.md
      - using_xtrabackup/comparison.md
      - xtrabackup_bin/xtrabackup_exit_codes.md
  - Backup scenarios:
      - backup_scenarios/full_backup.md
      - backup_scenarios/incremental_backup.md
      - backup_scenarios/compressed_backup.md
      - xtrabackup_bin/partial_backups.md
  - User’s manual:
      - manual.md
  - Advanced features:
      - advanced/throttling_backups.md
      - advanced/encrypted_innodb_tablespace_backups.md
      - xtrabackup_bin/backup.encrypting.md
      - xtrabackup_bin/lru_dump.md
      - xtrabackup_bin/point-in-time-recovery.md
      - advanced/smart_memory_estimation.md
      - xtrabackup_bin/working_with_binary_logs.md
      - advanced/log_enhancements.md
  - Security:
      - security/pxb-selinux.md
      - security/pxb-apparmor.md
  - Auxiliary guides:
      - howtos/enabling_tcp.md
      - howtos/ssh_server.md
      - xtrabackup_bin/analyzing_table_statistics.md
      - xtrabackup_bin/flush-tables-with-read-lock.md
      - advanced/locks.md
      - advanced/page_tracking.md
  - xbcloud binary:
      - xbcloud/xbcloud.md
      - xbcloud/xbcloud_swift.md
      - xbcloud/xbcloud_s3.md
      - xbcloud/xbcloud_minio.md
      - xbcloud/xbcloud_gcs.md
      - xbcloud/xbcloud_exbackoff.md
      - xbcloud/xbcloud_azure.md
  - Tutorials, recipes, how-tos:
      - how-tos.md
  - Release notes: 
      - Release notes index: release-notes.md 
      - release-notes/8.0/8.0.30-23.0.md
      - release-notes/8.0/8.0.29-22.0.md
      - release-notes/8.0/8.0.28-21.0.md
      - release-notes/8.0/8.0.28-20.0.md
      - release-notes/8.0/8.0.27-19.0.md
      - release-notes/8.0/8.0.26-18.0.md
      - release-notes/8.0/8.0.25-17.0.md
      - release-notes/8.0/8.0.23-16.0.md
      - release-notes/8.0/8.0.22-15.0.md
      - release-notes/8.0/8.0.14.md
      - release-notes/8.0/8.0.13.md
      - release-notes/8.0/8.0.12.md
      - release-notes/8.0/8.0.11.md
      - release-notes/8.0/8.0.10.md
      - release-notes/8.0/8.0.9.md
      - release-notes/8.0/8.0.8.md
      - release-notes/8.0/8.0.7.md
      - release-notes/8.0/8.0.6.md
      - release-notes/8.0/8.0.5.md
      - release-notes/8.0/8.0.4.md
      - release-notes/8.0/8.0-3-rc1.md
  - Error message descriptions:
      - em/instant.md
  - References:
      - xtrabackup_bin/xbk_option_reference.md
      - xbcrypt/xbcrypt.md
      - xbstream/xbstream.md
      - faq.md
      - glossary.md
      - xtrabackup-files.md
      - trademark-policy.md
      - copyright-and-licensing-information.md
      - version-check.md
# - Version Selector: "../"