mkdocs.yml

# Конфигурация MkDocs
# https://www.mkdocs.org/user-guide/configuration/

# Общие настройки
# site_name — https://www.mkdocs.org/user-guide/configuration/#site_name
# site_description — https://www.mkdocs.org/user-guide/configuration/#site_description
# site_url — https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#stay-on-the-same-page-when-switching-versions
# repo_url — https://www.mkdocs.org/user-guide/configuration/#repo_url
# edit_uri — https://www.mkdocs.org/user-guide/configuration/#edit_uri
site_name: Портал документации Picodata
site_description: Picodata documentation site
site_url: https://docs.picodata.io/picodata/
repo_url: https://git.picodata.io/picodata/picodata/docs
edit_uri: -/blob/main/docs/

# Исключения из навигации
# https://www.mkdocs.org/user-guide/configuration/#not_in_nav
not_in_nav: |
  index.md
  reference/api.md
  architecture/clusterwide_schema.md

# Навигация
# https://www.mkdocs.org/user-guide/configuration/#nav
nav:
  - Ознакомление с ПО Picodata:
    - overview/description.md
    - overview/benefits.md
    - overview/glossary.md
    - overview/feedback.md
    - overview/versioning.md
  - Инструкции и руководства:
    - tutorial/install.md
    - tutorial/run.md
    - tutorial/deploy.md
    - tutorial/connecting.md
    - tutorial/sql_examples.md
    - tutorial/webui.md
    - tutorial/access_control.md
    - tutorial/ldap.md
    - tutorial/monitoring.md
    - tutorial/audit_log.md
    - tutorial/backup.md
  - Справочные материалы:
    - reference/cli.md
    - Язык SQL:
      - reference/sql/dcl.md
      - reference/sql/ddl.md
      - reference/sql/dml.md
      - reference/sql/dql.md
      - reference/sql/non_block.md
      - reference/sql/object.md
      - reference/sql_types.md
      - reference/sql/parametrization.md
      - reference/ansi_sql.md
      - Команды:
        - reference/sql/alter_procedure.md
        - reference/sql/alter_user.md
        - reference/sql/call.md
        - reference/sql/create_procedure.md
        - reference/sql/create_role.md
        - reference/sql/create_table.md
        - reference/sql/create_user.md
        - reference/sql/delete.md
        - reference/sql/drop_procedure.md
        - reference/sql/drop_role.md
        - reference/sql/drop_table.md
        - reference/sql/drop_user.md
        - reference/sql/explain.md
        - reference/sql/grant.md
        - reference/sql/insert.md
        - reference/sql/revoke.md
        - reference/sql/select.md
        - reference/sql/update.md
        - reference/sql/values.md
      - Функции и операторы:
        - reference/sql/aggregate.md
        - reference/sql/cast.md
    - reference/audit_events.md
  - Архитектура:
    - architecture/distributed_sql.md
    - architecture/discovery.md
    - architecture/instance_lifecycle.md
    - architecture/instance_runtime_files.md
    - architecture/topology_management.md
    - architecture/raft_failover.md
    - architecture/system_tables.md
    - architecture/rpc_api.md
  - Обеспечение безопасности:
    - security/os.md
    - security/runtime.md
    - security/audit_log.md
    - security/integrity.md

# Настройки темы Material
  ## name, custom_dir — https://squidfunk.github.io/mkdocs-material/customization/#setup-and-theme-structure
  ## font — https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#regular-font
  ## logo — https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#logo
  ## favicon — https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#favicon
  ## language — https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language
  ## features:
    ### toc.follow — https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following
    ### content.code.copy — https://squidfunk.github.io/mkdocs-material/upgrade/#contentcodecopy
    ### content.action.edit — https://squidfunk.github.io/mkdocs-material/upgrade/#contentaction
    ### navigation.footer — https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#navigation
theme:
  name: material
  custom_dir: overrides
  font:
    text: Inter
  logo: assets/logo.svg
  icon: assets/icon.svg  # Custom setting
  favicon: assets/favicon.png
  language: ru
  features:
    - toc.follow
    - content.code.copy
    - content.action.edit
    - navigation.footer

# Дополнительные настройки темы Material
  ## analytics — https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#setting-up-site-analytics
  ## version — https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#configuration
  ## > version: provider: mike
  ## Активирует селектор версий `class="md-version"`.
  ## Список селектора `md-version__list` формируется из файла `versions.json`
  ## https://github.com/squidfunk/mkdocs-material/blob/9.4.8/src/templates/assets/javascripts/bundle.ts#L156
extra:
  analytics:
    provider: google
    property: G-6X8Z5N2CGR
    feedback:
      title: Была ли эта информация полезной для вас?
      ratings:
        - icon: material/emoticon-happy-outline
          name: Да, это было полезно
          data: 1
          note: >-
            Благодарим за отзыв!
        - icon: material/emoticon-sad-outline
          name: Страница требует улучшения
          data: 0
          note: >-
            Благодарим за отзыв! <a href="https://t.me/picodataru"
            target="_blank" rel="noopener">Напишите</a>, что бы вы хотели
            улучшить на этой странице или в целом на сайте документации.
  version:
    provider: mike

# Кастомизация CSS
# https://www.mkdocs.org/user-guide/configuration/#extra_css
extra_css:
  - extra/style.css

# Плагины MkDocs
# https://www.mkdocs.org/user-guide/configuration/#plugins
  ## > inline-svg
  ## Вставляет изображения формата `.svg` с относительными ссылками
  ## https://pypi.org/project/mkdocs-plugin-inline-svg/
  ## > open-in-new-tab
  ## Вставляет атрибуты `target="_blank"` и `rel="noopener"` во внешние ссылки
  ## https://github.com/JakubAndrysek/mkdocs-open-in-new-tab
  ## > search
  ## Добавляет в хедер панель поиска
  ## https://www.mkdocs.org/user-guide/configuration/#search
  ## https://squidfunk.github.io/mkdocs-material/plugins/search/
plugins:
  - inline-svg
  - open-in-new-tab
  - search:
      lang:
        - en
        - ru

# Расширения Python Markdown
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
  ## > attr_list
  ## Добавляет синтаксис для определения атрибутов различных элементов HTML в выводе Markdown.
  ## Используется для кастомизации якорей в формате {: #anchor }. Двоеточие и пробелы можно убирать
  ## https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
  ## https://python-markdown.github.io/extensions/attr_list/
  ## > callouts
  ## Добавляет синтаксис для оформления выносок — более простой, чем в расширении `admonition`
  ## https://oprypin.github.io/markdown-callouts/
  ## Описание типов выносок:
  ## https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
  ## > toc.permalink: true
  ## Добавляет ссылку на якорь в конце каждого заголовка
  ## https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink
  ## > toc.permalink_title
  ## Добавляет описание ссылки на якорь, которое отображается при наведении
  ## https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#+toc.permalink_title
markdown_extensions:
  - attr_list
  - callouts
  - toc:
      permalink: true
      permalink_title: Ссылка на абзац

# Валидация ссылок
# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  links:
    unrecognized_links: warn

# https://www.mkdocs.org/user-guide/configuration/#hooks
hooks:
  - ./hooks/add_meta.py
  - ./hooks/exclude_sitemap.py
  - ./hooks/filter_logs.py
  - ./hooks/check_headers.py
  - ./hooks/check_padding.py
  - ./hooks/check_svg_attrs.py
  - ./hooks/check_unused_svg.py
  - ./hooks/check_links.py
  - ./hooks/check_sorting.py
  - ./hooks/validate_system_tables.py