mlango/mkdocs.yml at master · DrobyshevDev/mlango · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
site_name: mlango
site_description: A batteries-included framework for machine learning, analytics and LLM agents.
site_url: https://drobyshevdev.github.io/mlango/
repo_url: https://github.com/DrobyshevDev/mlango
repo_name: DrobyshevDev/mlango
edit_uri: edit/master/docs/
copyright: MIT licensed. Not affiliated with the Django Software Foundation.

theme:
  name: material
  language: en
  features:
    # navigation.instant is deliberately absent: it breaks the i18n language
    # switcher, and a working switcher matters more for an international project.
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  # One file per translation: docs/index.md is English, docs/index.ru.md is
  # Russian. Pages without a translation fall back to English, so adding a
  # language never leaves a broken navigation tree.
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: ru
          name: Русский
          build: true
          site_name: mlango
          site_description: >-
            Фреймворк для машинного обучения, аналитики и LLM-агентов
            с батарейками в комплекте.
          nav_translations:
            Getting started: Начало работы
            Introduction: Введение
            Tutorial: Учебник
            Notebooks: Ноутбуки
            Concepts: Концепции
            Philosophy: Философия
            Architecture: Архитектура
            vs. the alternatives: Сравнение с альтернативами
            Building blocks: Строительные блоки
            Datasets: Датасеты
            Models: Модели
            Agents: Агенты
            Evaluations: Оценка
            Operating a project: Эксплуатация проекта
            Admin: Админка
            Serving: Развёртывание
            Monitoring: Мониторинг
            Settings: Настройки
            Command line: Командная строка
            Continuous integration: Непрерывная интеграция
            Migrations: Миграции
            Community: Сообщество
            Extending: Расширение
            Contributing: Как участвовать
            Translating: Перевод

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      # Diagrams live in the repository as text, so they can be reviewed in a
      # diff and edited by anyone, instead of as images only one person can open.
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

nav:
  - Getting started:
      - Introduction: index.md
      - Tutorial: tutorial.md
      - Notebooks: notebooks.md
      - Concepts: concepts.md
      - Philosophy: philosophy.md
      - Architecture: architecture.md
      - vs. the alternatives: comparison.md
  - Building blocks:
      - Datasets: datasets.md
      - Models: models.md
      - Agents: agents.md
      - Evaluations: evals.md
  - Operating a project:
      - Admin: admin.md
      - Serving: serving.md
      - Monitoring: monitoring.md
      - Migrations: migrations.md
      - Command line: cli.md
      - Continuous integration: ci.md
      - Settings: settings.md
      - Extending: extending.md
  - Community:
      - Contributing: contributing.md
      - Translating: translating.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DrobyshevDev/mlango