mkdocs-base.yml

# MkDocs configuration for  builds with Material theme

site_name: Percona Distribution for PostgreSQL
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/postgresql-docs
repo_url: https://github.com/percona/postgresql-docs
edit_uri: edit/17/docs/

use_directory_urls: false

# Material theme features
theme:
  name: material
  logo: _images/postgresql-mark.svg
  favicon: _images/postgresql-fav.svg
  custom_dir: _resource/overrides/
  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
    - navigation.tracking 
    - 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/percona.css
  - css/extra.css
  - css/design.css
  - css/osano.css
  - css/landing.css
  - css/postgresql.css

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

markdown_extensions:
  attr_list: {}
  toc:
    permalink: True
    title: On this page
  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:
      use_pygments: true
  pymdownx.inlinehilite: {}
  pymdownx.snippets:
      base_path: ["snippets"]
      auto_append:
        - services-banner.md
  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:
  section-index: {}
  search: 
    separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  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/PerconaDistributionPostgreSQL-17.pdf'
          cover_title: 'Distribution for PostgreSQL Documentation'

          cover_subtitle: 17.2 (December 26, 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
  postgresrecommended: 16

nav:
  - 'Home': 'index.md'
  - 'Percona Server for PostgreSQL': postgresql-server.md
  - Get started: 
      - Quickstart guide: installing.md
      - 1. Install: 
          - Via apt: apt.md
          - Via yum: yum.md
          - From tarballs: tarball.md
          - Run in Docker: docker.md
          - enable-extensions.md
          - repo-overview.md
      - 2. Connect to PostgreSQL: connect.md
      - 3. Manipulate data in PostgreSQL: crud.md  
      - 4. What's next: whats-next.md 
  - Extensions:
      - 'Extensions': extensions.md
      - contrib.md
      - Percona-authored extensions: percona-ext.md
      - third-party.md
  - Solutions:
      - Overview: solutions.md
      - High availability:
          - 'High availability': 'solutions/high-availability.md'
          - 'Deploying on Debian or Ubuntu': 'solutions/ha-setup-apt.md'
          - 'Deploying on RHEL or derivatives': 'solutions/ha-setup-yum.md'
          - solutions/pgbackrest.md
          - solutions/ha-test.md
      - Backup and disaster recovery:
          - 'Overview': 'solutions/backup-recovery.md'
          - solutions/dr-pgbackrest-setup.md
      - Spatial data handling:
        - Overview: solutions/postgis.md
        - Deployment: solutions/postgis-deploy.md
        - Query spatial data: solutions/postgis-testing.md
        - Upgrade spatial database: solutions/postgis-upgrade.md
      - LDAP authentication:
          - ldap.md
  - Upgrade:
      - "Major upgrade": major-upgrade.md
      - minor-upgrade.md
      - migration.md
  - Troubleshooting guide: troubleshooting.md
  - Uninstall: uninstalling.md
  - Release Notes:
      - "Release notes index": "release-notes.md"
      - release-notes-v17.2.md
      - release-notes-v17.0.md
  - Reference:
      - Telemetry: telemetry.md
      - Licensing: licensing.md
      - Trademark policy: trademark-policy.md