mhdocs/mkdocs.yml at main · DevCraftClub/mhdocs · 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
147
148
149
150
151
152
153
154
155
156
157
158
site_name: DevCraft Документации
repo_url: https://github.com/DevCraftClub/mhdocs
repo_name: DevCraftClub/mhdocs
edit_uri: edit/main/docs/
site_url: https://readme.devcraft.club
site_author: Maxim Harder
site_description: "Сайт с документациями, который построен на Python и системе MKDocs. Исходники всегда будут доступны на GitHub."
copyright: "Документация защищена лицензией <a href='https://github.com/DevCraftClub/mhdocs/blob/master/LICENSE.md'>MIT license</a>"

# Навигация автоматически генерируется плагином awesome-nav
# на основе структуры папок в docs/
# Для кастомизации можно использовать файлы .nav.yml в папках

theme:
  name: material
  colorscheme: monokai
  language: ru
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.instant
    - navigation.tracking
    #    - navigation.tabs
    #    - navigation.tabs.sticky
    - navigation.sections
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
  palette:
    primary: indigo
  consent:
    title: Cookie сайта
    description: > # (1)
      Мы используем файлы cookie для распознавания ваших повторных посещений и предпочтений, а также
      для оценки эффективности нашей документации и того, находят ли пользователи
      то, что ищут. Давая своё согласие, вы помогаете нам
      улучшать нашу документацию.

plugins:
  - search:
      lang:
        - ru
        - de
        - en
      separator: '[\s\-,:!=\[\]()"/]+'
  - localsearch
  - exclude
  - exclude-search
  - git-revision-date
  - tags:
      listings_map:
        scoped:
          scope: true
  - autorefs:
      resolve_closest: true
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
  - redirects:
      redirect_maps:
        "dev/paid-seasonvar/00_install.md": "dev/paid-seasonvar/install.md"
        "dev/paid-seasonvar/01_related.md": "dev/paid-seasonvar/related.md"
        "dev/paid-seasonvar/02_faq.md": "dev/paid-seasonvar/faq.md"
        "dev/telegramposting/00_install.md": "dev/telegramposting/install.md"
        "dev/telegramposting/01_changelog.md": "dev/telegramposting/changelog.md"
  - awesome-nav
  - section-index
  - git-revision-date-localized:
      enable_creation_date: true
      type: datetime
      timezone: Europe/Berlin
  - autolinks
  - mermaid2
  - glightbox:
      touchNavigation: true
      loop: true
  - import-statement
  - meta-manager
  - git-authors:
      show_email_address: false
      show_contribution: true
      add_co_authors: true
      ignore_authors:
        - m.harder@bsg.de
  - htmlproofer
  - link-marker
  - neoteroi.mkdocsoad:
      use_pymdownx: true

markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - markdown_version_annotations:
      version_added_title: "\\1: Добавлен новый функционал"
      version_changed_title: "\\1: Изменения в существующем функционале"
      version_removed_title: "\\1: Удаление функционала или очистка проекта"
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
      use_pygments: true
      auto_title: true
  #    - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

extra:
  homepage: https://devcraft.club
  analytics:
    provider: google
    property: G-6B531VYCBD
  version:
    provider: mike
  generator: false
  social:
    - icon: fontawesome/solid/paper-plane
      link: https://t.me/maharder
      name: Telegram

  search_metadata_file: docs/search-metadata.yml
  search_synonyms: true
  search_categories: true
  search_weights: true

extra_javascript:
  - extras/js/search-metadata-loader.js
  - extras/js/search-enhancement.js

extra_css:
  - extras/css/all.min.css
  - extras/css/search-enhancement.css
  - extras/css/styles.css