mkdocs-material-extras/mkdocs.yml at main · Dup4/mkdocs-material-extras · 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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
site_name: Mkdocs Material Extras
site_url: https://dup4.com/mkdocs-material-extras/
site_author: Dup4
site_description: >-
  Mkdocs Material Extras

# Repository
repo_name: mkdocs-material-extras
repo_url: https://github.com/Dup4/mkdocs-material-extras
edit_uri: tree/main/docs

# Copyright
copyright: Copyright &copy; 2022 - Present <a href="https://github.com/Dup4" target="_blank" rel="noopener">Dup4</a>

# Configuration
theme:
  name: material

  # Static files
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  language: en

  features:
    - header.autohide
    # - navigation.instant
    # - navigation.expand
    # - navigation.sections
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.indexes
    - search.highlight
    - search.share
    - search.suggest
    - toc.integrate
    - content.code.annotate

    # insiders only
    # - content.tabs.link

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: dracula
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    logo: material/airplane

# Plugins
plugins:
  - search:
      lang: ja
  - rss
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
  - minify:
      minify_html: true
  - redirects:
      redirect_maps:
        "index.md": "tutorial/abbreviations.md"
  - mkdocs-material-extras:
      enable_mathjax: !ENV [ENABLE_MATHJAX, true]

# Customization
extra:
  generator: false
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Dup4/mkdocs-material-extras

# Extensions
markdown_extensions:
  - admonition:
  - abbr:
  - attr_list:
  - def_list:
  - footnotes:
  - md_in_html:
  - meta:
  - markdown.extensions.smarty:
      smart_quotes: false
  - markdown.extensions.tables:
  - markdown.extensions.toc:
      slugify: !!python/name:pymdownx.slugs.uslugify
      permalink: ""
      toc_depth: 2-3
  - pymdownx.arithmatex:
  - pymdownx.betterem:
  - pymdownx.caret:
  - pymdownx.critic:
  - pymdownx.keys:
  - pymdownx.tilde:
  - pymdownx.mark:
  - pymdownx.details:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      linenums: true
      linenums_style: pymdownx-inline
      anchor_linenums: true
  - pymdownx.inlinehilite:
      custom_inline:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.inline_mathjax_format
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      social_url_shortener: true
      normalize_issue_symbols: true
  - pymdownx.smartsymbols:
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: false
  - pymdownx.escapeall:
      hardbreak: true
      nbsp: true
  - pymdownx.progressbar:
  - pymdownx.striphtml:
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.saneheaders:

docs_dir: docs

# Page tree
nav:
  - Tutorial:
    - Abbreviations: tutorial/abbreviations.md
    - Arithmatex: tutorial/arithmatex.md
    - BetterEm: tutorial/betterem.md
    - Buttons: tutorial/buttons.md
    - Caret: tutorial/ceret.md
    - Critic: tutorial/critic.md
    - Code Blocks: tutorial/code-blocks.md
    - Data tables: tutorial/data-tables.md
    - Details: tutorial/details.md
    - Diagrams: tutorial/diagrams.md
    - Footnotes: tutorial/footnotes.md
    - Images: tutorial/images.md
    - Table of Contents: tutorial/table-of-contents.md