mkdocs-base.yml

# MkDocs configuration for Netlify builds

site_name: Percona XtraBackup
site_description: Percona XtraBackup is an open source hot backup utility, for MySQL - based servers, that keeps your database fully available during planned maintenance windows.
site_author: Percona LLC

repo_name: percona/pxb-docs
repo_url: https://github.com/percona/pxb-docs
edit_uri: edit/innovation-release/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

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

#Copyright
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>

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])'

extra:
  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/release-notes.md
    - release-notes/8.2.0-1.md
    - release-notes/8.1.0-1.md
  - Quickstart Guide:
      - quickstart-overview.md
  - How Percona XtraBackup works:
      - about-xtrabackup.md
      - features.md
      - limitations.md
      - how-xtrabackup-works.md
      - xtrabackup-version-numbers.md
  - Features:
      - Backup features:
        - lru-dump-backup.md
        - throttling-backups.md
        - store-backup-history.md
      - Prepare features:
        - dictionary-cache.md
      - Restore features:
        - point-in-time-recovery.md
        - restore-individual-tables.md
      - encrypted-innodb-tablespace-backups.md
      - flush-tables-with-read-lock.md
      - log-enhancements.md
      - lock-options.md
      - smart-memory-estimation.md
      - working-with-binary-logs.md
  - Binaries:
    - Overview: binaries-overview.md
    - The xtrabackup binary:
      - xtrabackup-binary-overview.md
      - xtrabackup-implementation-details.md
      - xtrabackup-option-reference.md
      - configure-xtrabackup.md
    - The xbcrypt binary:
      - xbcrypt-binary-overview.md
      - xbcrypt-options.md
    - The xbstream binary:
      - xbstream-binary-overview.md
      - xbstream-options.md
      - take-streaming-backup.md
      - accelerate-backup-process.md
      - encrypt-backups.md
    - The xbcloud binary:
      - xbcloud-binary-overview.md
      - xbcloud-options.md
      - Use the xbcloud binary:
        - xbcloud-s3.md
        - xbcloud-iam-profile.md
        - xbcloud-swift.md
        - xbcloud-gcs.md
        - xbcloud-azure.md
        - xbcloud-minio.md
      - xbcloud-binary-fifo-datasink.md
      - xbcloud-exbackoff.md
  - Install:
      - installation.md
      - Before you start:
        - server-backup-version-comparison.md
        - privileges.md
        - permissions.md
      - Use APT:
        - Use APT repositories: apt-repo.md
        - Files in DEB package: apt-files.md
        - Downloaded DEB packages: apt-download-deb.md
        - Apt pinning: apt-pinning.md
        - work-with-apparmor.md
        - Uninstall: apt-uninstall-xtrabackup.md
      - Use YUM:
        - Use RPM repositories: yum-repo.md
        - Files in RPM package: yum-files.md
        - Downloaded RPM packages: yum-download-rpm.md
        - work-with-selinux.md
        - Uninstall: yum-uninstall-xtrabackup.md
      - Use binary tarballs:
        - Install with binary tarballs: binary-tarball.md
        - Binary tarballs available: binary-tarball-names.md
      - Compile from source:
        - compile-xtrabackup.md
      - Docker:
        - docker.md
#  - Upgrade:
#      - upgrade.md
  - How to:
      - Take a full backup:
        - create-full-backup.md
        - prepare-full-backup.md
      - Take an incremental backup:
        - create-incremental-backup.md
        - prepare-incremental-backup.md
        - page-tracking.md
      - Take a compressed backup:
        - create-compressed-backup.md
        - prepare-compressed-backup.md
      - Take a partial backup:
        - create-partial-backup.md
        - prepare-partial-backup.md
      - Back up individual partitions:
        - create-individual-partition-backup.md
        - prepare-individual-partitions-backup.md
      - Restore a backup:
        - Restore full, incremental, compressed backups: restore-a-backup.md
        - restore-partial-backup.md
        - Restore an individual partitions backup: restore-individual-partitions.md
      - Replicate:
        - set-up-replication.md
        - create-gtid-replica.md
        - make-backup-in-replication-env.md
        - varify-backup.md
  - Troubleshoot:
      - xtrabackup-exit-codes.md
      - update-curl-utility.md
  - Reference:
    - xtrabackup-files.md
    - faq.md
    - glossary.md
    - toolkit-version-check.md
    - trademark-policy.md
    - copyright-and-licensing-information.md