documentation/mkdocs.yml at main · MxUserBot/documentation · 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
site_name: MXUserBot Docs
site_description: Документация MXUserbot — Matrix Userbot
site_author: MXUserBot
site_url: https://mxuserbot.github.io/documentation/
repo_url: https://github.com/MxUserBot/MXUserbot
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: ru
          default: true
          name: Русский
          build: true
        - locale: en
          name: English
          build: true
          nav_translations:
            Главная: Home
            Преимущества: Advantages
            Системные модули: System Modules
            PingPong: PingPong
            Helper: Helper
            Prefix: Prefix
            Verifier: Verifier
            Shell: Shell
            Loader: Loader
            Разработка модулей: Module Development
            Как это работает: How It Works
            Ключевые концепции: Key Concepts
            SAS верификация: SAS Verification
            Эмодзи коллбеки: Emoji Callbacks
            Написание модулей: Writing Modules
            Введение: Introduction
            База: Basics
            Команды: Commands
            Ответы и утилиты: Answers & Utils
            Watcher/Cron/Events: Watcher/Cron/Events
            FSM: FSM
            Безопасность: Security System
            ZIP модули: ZIP Modules
            Распространение модулей: Distribute Modules
            Справочник utils: Utils Reference
            Обзор: Overview

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - tables
  - codehilite

nav:
  - Главная: index.md
  - Преимущества: pros-cons.md
  - Как это работает: how-it-works.md
  - Ключевые концепции: key-concepts.md
  - Системные модули:
    - PingPong: system_modules/ping.md
    - Helper: system_modules/help.md
    - Prefix: system_modules/prefix.md
    - Security: system_modules/sudo.md
    - Verifier: system_modules/verif.md
    - Shell: system_modules/shell.md
    - Loader: system_modules/loader.md
  - Разработка модулей:
    - Обзор: writing-modules/index.md
    - База: writing-modules/basics.md
    - Команды: writing-modules/commands.md
    - Ответы и утилиты: writing-modules/answer-utils.md
    - Watcher/Cron/Events: writing-modules/watcher-cron-events.md
    - FSM: writing-modules/fsm.md
    - Эмодзи коллбеки: writing-modules/emoji-callbacks.md
    - Безопасность: writing-modules/security.md
    - ZIP модули: writing-modules/zip-modules.md
    - Распространение модулей: writing-modules/distribute.md
    - Справочник utils: writing-modules/utils-reference.md
    - SAS верификация: writing-modules/sas-verification.md