x2rs.github.io/mkdocs.yml at main · x2rs/x2rs.github.io · 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
site_name: x2rs的小站
site_url: https://x2rs.github.io
site_author: x2rs
site_description: My personal documentation website.

nav:
  - 主页:
    - index.md
    - todo.md
  - 笔记:
    - notes/regex.md
    - notes/physics.md
  - 实用应用:
    - useful-apps/index.md
    - useful-apps/ai/CharacterGLM.md
    - useful-apps/ai/ChatGLM.md
    - useful-apps/ai/CodeGeeX.md
    - useful-apps/browser-extensions/infinite-pro.md
    - useful-apps/browser-extensions/ndm.md
    - useful-apps/index.md
    - useful-apps/others/pigcha.md
    - useful-apps/tool/everything.md
    - useful-apps/tool/geek-uninstaller.md
    - useful-apps/tool/space-sniffer.md
  - Learn Intern LM:
    - internlm/l0-linux.md
    - internlm/l0-python.md
  - 未分类:
    - matlab/simple_linear.md
    - notes/python-venv.md
    - notes/Cramer-Rao.md
    - notes/order-of-destructor-calls.md
    - notes/strong-and-weak-symbol.md
    - notes/cpp-derived-class-access.md
    - notes/sc-i8042prt.md

theme:
  name: material
  # [给每个页面添加giscus]
  # https://github.com/x2rs/x2rs.github.io/issues/6
  custom_dir: overrides
  # [切换日间模式和夜间模式]
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle
  palette:
    # 日间模式
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/lightbulb-auto
        name: 切换至日间模式

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: orange
      toggle:
        icon: material/lightbulb
        name: 切换至夜间模式

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: orange
      toggle:
        icon: material/lightbulb-outline
        name: 切换至系统偏好
  language: zh # 一些提示性的文字会变成中文

  features:
    # 使用 Tab 来进行分类
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
    - navigation.tabs
    # 返回顶部的按钮，在上滑时出现
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
    - navigation.top
    # 给每个 Tab 添加一个 index.md，且在点击 Tab 时打开
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages-with-section-index-pages
    - navigation.indexes
    # 打开 Tab 时左侧目录全部展开
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-expansion
    - navigation.expand
    # 搜索输入一些字母时推荐补全整个单词
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions
    - search.suggest
    # 搜索的关键词文章加入高亮
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting
    - search.highlight
    # 可以通过按钮复制代码
    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
    - content.code.copy
    # [点击按钮跳转至 GitHub 修改 Markdown 源文件]
    # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
    - content.action.edit
    # [点击按钮跳转至 GitHub 查看 Markdown 源代码]
    # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
    - content.action.view

# [显示页面修改日期]
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/?h=revision+date#document-dates
plugins:
  # [搜索功能]
  # 注意：如果在配置文件中还没有 plugins 条目，您可能还想添加 search 插件。MkDocs 在没有设置 plugins 条目时默认启用搜索功能，但现在您需要显式启用它。
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: iso_date

# [点击按钮跳转至 GitHub 修改 Markdown 源文件]
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
edit_uri: edit/main/docs/
# [top-right corner]
# [添加 GitHub 仓库]
# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/
repo_url: https://github.com/x2rs/x2rs.github.io
repo_name: x2rs.github.io

markdown_extensions:
  # [代码语法高亮]
  # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-blocks
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
  - admonition
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight:
      # 显示行号
      linenums: true
      # 显示编程语言名称
      auto_title: true
      # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.line_spans
      line_spans: __span
      # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#+pymdownx.highlight.pygments_lang_class
      pygments_lang_class: true
  # [任务清单勾选框]
  # https://squidfunk.github.io/mkdocs-material/reference/lists/#configuration
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  # [数学公式支持]
  # https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  # [数学公式支持]
  # https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js