mkdocs/mkdocs.yml at master · cuzperf/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
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
# prepare (need venv if default python is python2)

# pip install mkdocs mkdocs-bootswatch pymdown-extensions
# pip install mkdocs-material mkdocs-rss-plugin python-markdown-math
# pip install mkdocs-encryptcontent-plugin

# Personal info (replace cuzperf to username, mkdocs to repo name)

site_name: mkdocs template
site_author: 'cuzperf'
site_url: 'https://cuzperf.github.io/mkdocs'

repo_name: cuzperf/mkdocs
repo_url: https://github.com/cuzperf/mkdocs

copyright: Copyright © 2022 cuzperf

# Contents
nav:
  - 主页:
    - 示例: index.md
  - 关于: about.md

theme:
  name: material
  language: zh
  custom_dir: docs/theme
  highlightjs: true
  icon:
    repo: fontawesome/brands/git-alt
  logo: img/favicon.ico
  favicon: img/cuzperf.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
    - scheme: slate
      primary: deep purple
      accent: blue
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.expand
    - search.suggest
    - search.highlight
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cuzperf/mkdocs
    - icon: fontawesome/solid/rss
      link: feed_rss_updated.xml

markdown_extensions:
  - admonition
  - footnotes
  - meta
  - mdx_math:
      enable_dollar_delimiter: True
  # - pymdownx.arithmatex
  # - pymdownx.arithmatex:
      # generic: true
  - pymdownx.caret
  - pymdownx.tabbed
  - pymdownx.tilde
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.mark
  - 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.inlinehilite:
      custom_inline:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.inline_mathjax_format
  - codehilite:
      guess_lang: false
      linenums: true
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
#  - pymdownx.emoji:
#      emoji_generator: !!python/name:pymdownx.emoji.to_svg
#  - pymdownx.magiclink
  - pymdownx.tasklist:
      custom_checkbox: true


extra_javascript:
# mathjax2（mathjax3 有 bug）:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'

extra_css:
  - https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css

plugins:
  - search
  - rss