mkdocs-base.yml

# MkDocs configuration for builds with material theme

site_name: Percona Distribution for MongoDB 4.4
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/distmongo-docs
repo_url: https://github.com/percona/distmongo-docs
edit_uri: edit/4.4/docs/

use_directory_urls: false

# Theme setup
theme:
  name: material
  logo: _images/percona-logo.svg
  favicon: _images/percona-favicon.ico
  custom_dir: _resource/overrides/
  font:
    text: Roboto
    code: Roboto Mono
  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.share
    - search.highlight
    - content.account.copy
    - content.action.view
    - content.action.edit
    - content.tabs.link
    - navigation.top
    - navigation.tracking 


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
  - css/extra.css
  - css/osano.css
  - css/design.css


extra_javascript:
  - js/version-select.js
  - js/promptremover.js
  - ja/consent.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/.icons
       

plugins:
  search: 
    separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  section-index: {}
  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
  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/PerconaDistributionforMongoDB-4.4.pdf'
          cover_title: 'Distribution for MongoDB Documentation 4.4'
          cover_subtitle: 4.4.29 (April 2, 2024)
          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/percona-for-mongodb

nav:
  - Home:
      - index.md
  - Release notes: 
      - "Release notes index": "release-notes.md"
      - release-notes-v4.4.29.md
      - release-notes-v4.4.28.md
      - release-notes-v4.4.27.md
      - 2023 (versions 4.4.19 to 4.4.26):
        - release-notes-v4.4.26.md
        - release-notes-v4.4.25.md
        - release-notes-v4.4.24.md
        - release-notes-v4.4.23.md
        - release-notes-v4.4.22.md
        - release-notes-v4.4.21.md
        - release-notes-v4.4.19.md
      - 2022 (versions 4.4.12 to 4.4.18):
        - release-notes-v4.4.18.md
        - release-notes-v4.4.17.md
        - release-notes-v4.4.16.md
        - release-notes-v4.4.15.md
        - release-notes-v4.4.14.md
        - release-notes-v4.4.13.md
        - release-notes-v4.4.12.md
      - 2021 (versions 4.4.3 to 4.4.10): 
        - release-notes-v4.4.10.md
        - release-notes-v4.4.9.md
        - release-notes-v4.4.8.md
        - release-notes-v4.4.6.md
        - release-notes-v4.4.5.md
        - release-notes-v4.4.4.md 
        - release-notes-v4.4.3.md
      - 2020 (version 4.4.0 to 4.4.2): 
        - release-notes-v4.4.2.md
        - release-notes-v4.4.1.upd.md
        - release-notes-v4.4.1.md
        - release-notes-v4.4.0.md 
  - Installation and upgrade: 
      -  Install Percona Distribution for MongoDB:
         - installation.md
      - repo-overview.md
      - minor-upgrade.md
  - Reference:
    - Copyright and licensing: copyright.md
    - trademark-policy.md