mkdocs/mkdocs.yml at main · maltonoloco/mkdocs · 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
site_name: MkDocs Dokumentation
site_url: http://localhost:8000/
site_author: "Malte Kottmann"
repo_url: https://github.com/maltonoloco/mkdocs_test_doc
repo_name: maltonoloco/mkdocs_test_doc
edit_uri: ""
docs_dir: /docs
site_dir: /site

theme:
  name: material
  palette:
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Dark mode
      primary: green
      accent: deep purple

    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Light mode
      primary: blue
      accent: deep orange

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant

nav:
  - Home: index.md
  - Doc: Test_docs.md
  - Guides:
    - First Guide: guides/guide1.md
    - Second Guide: guides/guide2.md
  - Reference:
    - Module A: reference/module_a.md
    - Module B: reference/module_b.md
  - Code:
    - Python Code: code-bsp.md

# Mike and search plugins
plugins:
  - search
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra:
  version:
    provider: mike