Skip to content
Snippets Groups Projects
mkdocs.yml 3.07 KiB
Newer Older
Alexander Tolstoy's avatar
Alexander Tolstoy committed
site_name: Портал документации Picodata
Alexander Tolstoy's avatar
Alexander Tolstoy committed
site_description: Picodata documentation site
repo_url: https://git.picodata.io/picodata/picodata/docs
edit_uri: https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/
Alexander Tolstoy's avatar
Alexander Tolstoy committed
nav:
  - Ознакомление с ПО Picodata:
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    - overview/description.md
    - overview/benefits.md
    - overview/glossary.md
    - overview/feedback.md
  - Инструкции и руководства:
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    - tutorial/install.md
    - tutorial/deploy.md
    - tutorial/monitoring.md
    - tutorial/connecting.md
    - tutorial/webui.md
    - tutorial/ldap.md
    - tutorial/tutorial_users.md
    - tutorial/sql_examples.md
  - Справочные материалы:
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    - reference/cli.md
    - reference/sql_types.md
    - reference/sql_queries.md
    - reference/api.md
    - reference/ansi_sql.md
  - Архитектура:
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    - architecture/distributed_sql.md
    - architecture/discovery.md
    - architecture/raft_failover.md
    - architecture/clustering.md
    - architecture/system_tables.md
theme:
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    name: material
    custom_dir: overrides
    font:
        text: Inter
    logo: assets/logo-full.svg
    logo_mobile: assets/logo.svg
    favicon: assets/favicon.png
    language: ru
Alexander Tolstoy's avatar
Alexander Tolstoy committed
    features:
        - navigation.indexes
        - navigation.path
        - toc.follow
Alexander Tolstoy's avatar
Alexander Tolstoy committed
        - content.code.copy
    homepage: https://docs.picodata.io/
    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
            Благодарим за отзыв! <a href="https://t.me/picodataru" target="_blank" rel="noopener">Напишите</a>, что бы вы хотели улучшить на этой странице или в целом на сайте документации.
Alexander Tolstoy's avatar
Alexander Tolstoy committed
extra_css:
    - extra/style.css
    - inline-svg # рендерит svg-файлы как часть html-кода
    - macros: # нужен для использования хуков для ссылок вида "Исходный код страницы".
    # См. https://mkdocs-macros-plugin.readthedocs.io/en/latest и https://github.com/mkdocs/mkdocs/blob/master/docs/hooks.py
        on_error_fail: true # не стартовать, если найдены ошибки
        on_undefined: strict # по умолчанию использовать строгий режим
    - git-revision-date-localized: # печатает дату изменения страницы внизу
        enable_creation_date: false
    - search: # поиск по сайту
markdown_extensions:
  - attr_list
  - md_in_html
Alexander Tolstoy's avatar
Alexander Tolstoy committed
        permalink: False