sdvg/mkdocs.yml at master · tarantool/sdvg · 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
site_name: "SDVG"
site_url: "https://tarantool.github.io/sdvg"
repo_url: "https://github.com/tarantool/sdvg"
repo_name: "tarantool/sdvg"

### BUILD ###

docs_dir: "doc"
exclude_docs: |
  build/*

validation:
  omitted_files: "warn"
  absolute_links: "warn"
  unrecognized_links: "warn"
  anchors: "warn"

nav:
  - "index.md"
  - "usage.md"
  - "contributing.md"
  - "overview.md"
  - "changelog.md"
  - "license.md"

extra_css:
  - "assets/stylesheets/sdvg.css"

### APPEARANCE ###

theme:
  name: "material"
  logo: "assets/images/favicon.png"
  favicon: "assets/images/favicon.png"
  icon:
    repo: "fontawesome/brands/github"
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        name: "Switch to light mode"
        icon: "material/brightness-auto"
    - media: "(prefers-color-scheme: light)"
      scheme: "default"
      toggle:
        name: "Switch to dark mode"
        icon: "material/brightness-7"
    - media: "(prefers-color-scheme: dark)"
      scheme: "slate"
      toggle:
        name: "Switch to system preference"
        icon: "material/brightness-4"

  features:
    - "content.code.copy" # copy button for code sections
    - "navigation.footer"
    - "navigation.path"
    - "navigation.indexes"
    - "navigation.sections"
    - "navigation.expand"
    - "toc.follow"
    - "search.highlight"

extra:
  generator: false # disable footer note 'Made with Material for MkDocs'

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
  - pymdownx.inlinehilite:
  - attr_list:
  - codehilite:
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify # for cyrillic
        kwds:
          case: "lower"

plugins:
  - include-markdown:
  - mkdocs-simple-hooks:
      hooks:
        on_page_markdown: "doc.build.hooks:replace_specific_links"
  - search:
  - i18n:
      docs_structure: "folder"
      fallback_to_default: true
      reconfigure_search: true
      reconfigure_material: true
      languages:
        - locale: "en"
          name: "English"
          default: true
        - locale: "ru"
          name: "Русский"