template-mkdocs-material/mkdocs.yml at main · sosiristseng/template-mkdocs-material · 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
site_name: My MkDocs Template
site_url: !ENV [SITE_URL, 'https://sosiristseng.github.io/template-mkdocs-material/']
site_author: Wen-Wei Tseng

# Repository
repo_url: !ENV [REPO_URL, 'https://github.com/sosiristseng/template-mkdocs-material/']
repo_name: !ENV [REPO_NAME, 'sosiristseng/template-mkdocs-material']
edit_uri: 'edit/main/docs/' # Leave blank to disable the edit button,

copyright: Copyright &copy; 2016 - 2025 Wen-Wei Tseng

# Nav bar
# Uncomment to customize nav bar
# nav:
#   - Home: index.md
#   - About: about.md
#   - Blog:
#     - blog/index.md
#   - Markdown syntax:
#       - Basic markdown syntax: markdown/basic.md
#       - Advanced markdown syntax: markdown/advanced.md
#   - Tags: tags.md

# MkDocs plugins
plugins:
  - search
  - ezlinks
  - callouts
  - blog:
      enabled: true
      blog_dir: blog
      archive_date_format: yyyy-MM
  - tags:
      enabled: !ENV [CI, false]
      tags_hierarchy: true
  - git-revision-date-localized:
      enabled: !ENV [CI, false]
      enable_creation_date: !ENV [CI, false]

# Theme configuration
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: blue grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    # - navigation.expand
    # - navigation.indexes # Not compatible with toc.integrate
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  icon:
    repo: fontawesome/brands/github-alt

exclude_docs: |
  drafts/

# Social buttons at bottom
extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/user
    - icon: fontawesome/brands/github
      link: https://github.com/user
    - icon: fontawesome/brands/orcid
      link: https://orcid.org/0000-0000-0000-0000
    - icon: fontawesome/solid/paper-plane
      link: mailto:a@b.com

# Extensions:
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
# https://python-markdown.github.io/extensions/
# https://facelessuser.github.io/pymdown-extensions/
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 4
  - pymdownx.arithmatex:
      generic: true
  # - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.betterem:
      smart_enable:
  - pymdownx.blocks.caption
  # - pymdownx.critic
  - pymdownx.details
  - 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.keys
  - pymdownx.magiclink:
      repo_url_shortener: true
      user: 'sosiristseng'
      repo: 'template-mkdocs-material'
  # - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra_javascript:
  - _javascripts/config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - _stylesheets/extra.css

watch:
  - includes