mkdocs-base.yml

# MkDocs configuration for builds with material theme

site_name: Percona Server for MongoDB 8.0
site_description: Documentation
site_author: Percona LLC
copyright: >
  <a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024 — <a href="#__consent">Cookie Consent</a>


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

use_directory_urls: false

# Theme setup
theme:
  name: material
  logo: _images/mongodb-mark.svg
  favicon: _images/mongodb-fav.svg
  custom_dir: _resource/overrides/
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    edit: material/file-edit-outline
    view: material/file-eye-outline
  
  features:
    content.action.view
    content.action.edit
    content.code.copy
    content.copy.annotate
    content.tooltips
    search.highlight
    search.share
    search.suggest
    
  palette:
    
    # Automatic mode based on system preferences

    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

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

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

markdown_extensions:
  abbr: {}
  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: 
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.highlight:
      linenums: false
  pymdownx.inlinehilite: {}
  pymdownx.snippets:
      base_path: ["snippets"]
#       auto_append:
#         - services-banner.md
  pymdownx.tasklist:
      custom_checkbox: true
  pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - _resource/overrides/.icons

       

plugins:
#  section-index: {}
  search: 
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  git-revision-date-localized: 
    enable_creation_date: true
    enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
  meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
  glightbox: 
    touchNavigation: false
  git-committers:
    enabled: !ENV [CI, false]
    repository: percona/psmdb-docs
    branch: "8.0"
  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/PerconaServerforMongoDB-8.0.pdf'
          cover_title: 'Server for MongoDB Documentation 8.0'
          cover_subtitle: 8.0.4-2 (February 19, 2025)
          author: 'Percona Technical Documentation Team'
          cover_logo: docs/_images/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
#  homepage: https://docs.percona.com

nav:
  - Home: index.md
  - psmdb-pro.md
  - get-help.md
  - Get started: 
      - Quickstart guides: 'install/index.md'
      - 1. Installation:
        - 'System requirements': 'system-requirements.md'
        - install/cloud-deployments.md
        - "On Debian and Ubuntu": install/apt.md
        - "On RHEL and derivatives": install/yum.md
        - "On Amazon Linux 2023": install/amazon-linux.md
        - "From tarballs": install/tarball.md
        - install/source.md
        - "Run in Docker": install/docker.md
        - "Install Percona Server for MongoDB Pro": install/install-pro.md
      - "2. Connect to Percona Server for MongoDB": connect.md
      - "3. Manipulate data in Percona Server for MongoDB": crud.md
      - "4. What's next?": what-next.md
  - Features: 
      - Feature comparison with MongoDB: comparison.md
      - Storage:
        - "Percona Memory Engine": "inmemory.md"
      - Backup:
        - "Hot Backup": "hot-backup.md"
        - backup-cursor.md
      - Authentication:
        - "Authentication overview": "authentication.md"
        - enable-auth.md
        - sasl-auth.md
        - x509-ldap.md
        - kerberos.md
        - aws-iam.md
        - aws-iam-setup.md
        - authorization.md
        - ldap-setup.md
      - Encryption:
        - "Data at rest encryption": "data-at-rest-encryption.md"
        - "Use Vault": vault.md
        - "Use KMIP" : kmip.md
        - "Use local keyfile": keyfile.md
        - "Migrate from keyfile to Vault": encryption-mode-switch.md
        - fips.md
      - audit-logging.md 
      - rate-limit.md
      - log-redaction.md
      - ngram-full-text-search.md
  - Administration:
      - "Tune parameters": "set-parameter.md"
      - Upgrade:
        - "Upgrade from 7.0 to 8.0": "install/upgrade-from-70.md"
        - "Upgrade from MongoDB Community": "install/upgrade-from-mongodb.md"
        - "Upgrade to Percona Server for MongoDB Pro": install/update-pro.md
        - install/minor-upgrade.md
      - install/uninstall.md
  - Release notes:
      - "Release notes index": "release_notes/index.md"
      - release_notes/8.0.4-2.md
      - release_notes/8.0.4-1.md
  - faq.md
  - Reference:
      - glossary.md
      - telemetry.md
      - copyright.md
      - trademark-policy.md 
  - Join Percona Squad: "https://squad.percona.com/mongodb"