mkdocs-base.yml

# MkDocs base configuration that other conf files will inherit

site_name: Percona ProxySQL admin tools
site_description: Documentation
site_author: Percona LLC

repo_name: percona/proxysql-admin-tool-doc
repo_url: https://github.com/percona/proxysql-admin-tool-doc
edit_uri: edit/main/docs/

#features:
# - content.tabs.link

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.action.edit
    - content.action.view
    - content.code.copy

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/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
#  - htmlproofer # Uncomment to check links - but extends build time significantly
    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/PerconaProxySQLAdmintool-2.4.4.pdf'
#          cover_title: 'Percona ProxySQL Admin tool Documentation'
#          cover_subtitle:
#          author: 'Percona Technical Documentation Team'
#          cover_logo: docs/_static/Percona_Logo_Color.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

nav:
  - Home: index.md
  - get-help.md
  - ProxySQL 2.x.x Release notes:
      - Release notes index: release-notes.md
      - 2.7.1-1.md
      - 2.7.1.md
      - 2.6.5.md
      - 2.6.3.md
      - 2.6.2.md
      - 2.5.5-1.2.md
      - 2.5.5.md
      - 2.5.4.md
      - 2.5.3.md
      - 2.5.2.md
      - 2.5.1.md
      - 2.4.8.md
      - 2.4.7.md
      - 2.4.4-1.2.md
      - 2.4.4.md
      - 2.4.3.md
      - 2.4.2.md
      - release-notes-2.3.2-1.md
      - release-notes-2.3.2.md
      - release-notes-2.2.0.md
      - release-notes-2.1.1.md
      - release-notes-2.0.18.md
      - release-notes-2.0.17.md
      - release-notes-2.0.15.md
      - release-notes-2.0.14.md
      - release-notes-2.0.13.md
      - release-notes-2.0.12.md
      - release-notes-2.0.7.md
      - release-notes-2.0.6.md
      - release-notes-2.0.5.md
      - release-notes-2.0.4.md
      - release-notes-2.0.3.md
  - ProxySQL 2.x.x and admin tools:
      - Install:
        - where-to-download-proxysql.md
        - install-v2.md
        - install-proxysql2-tarball.md
        - build-psh.md
      - Deploy:
        - start-or-stop-proxysql2.md
        - upgrade-proxysql2.md
        - uninstall-proxysql2.md
      - proxysql-admin:
        - Manage:
          - proxysql-admin-tool-changes.md
          - proxysql-admin-tool-v2-config.md
          - proxysql-admin-tool-functions.md
      - pxc_scheduler_handler:
        - Manage:
          - psh-overview.md
          - psh-configuration.md
          - psh-options.md
          - psh-detailed-options.md
          - psh-known-limitations.md
  - ProxySQL 1.x.x and the proxysql-admin:
      - proxysql-v1.md
      - Release notes for ProxySQL 1.x.x: release-notes-index-v1.md
      - installing-v1.md
      - tarball-v1.md
      - configure-proxysql1.md
  - Reference:
      - trademark-policy.md
      - copyright-and-licensing-information.md

# - Version Selector: "../"