Skip to content

markdown 与 TeX 插件

可折叠块♪

YAML
1
2
3
4
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

注解♪

YAML
1
2
3
4
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.superfences

注解图标♪

如要自定义注解图标，需要如下代码：

YAML
1
2
3
theme:
  icon:
    annotation: material/icon_type

其中 icon_type 可选的有：plus-circle, circle-medium, record-circle, arrow-right-circle, arrow-right-circle-outline, chevron-right-circle, star-four-points-circle, plus-circle-outline。

按钮♪

YAML
1
2
markdown_extensions:
  - attr_list

代码块♪

YAML
1
2
3
4
5
6
7
8
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

代码复制♪

YAML
1
2
3
theme:
  features:
    - content.code.copy

代码高亮♪

如要自定义代码高亮，需要如下代码：

YAML
1
2
extra_css:
  - stylesheets/extra.css

其中，在 /docs/stylesheets/extra.css 中，需添加如下代码：

CSS
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
:root > * {
/* 以下以数字颜色为例： */
  --md-code-hl-number-color: #F4861F;
/* 其他可调参数：
  --md-code-hl-special-color
  --md-code-hl-function-color
  --md-code-hl-constant-color
  --md-code-hl-keyword-color
  --md-code-hl-string-color
  --md-code-hl-name-color
  --md-code-hl-operator-color
  --md-code-hl-punctuation-color
  --md-code-hl-comment-color
  --md-code-hl-generic-color
  --md-code-hl-variable-color
  --md-code-fg-color
  --md-code-bg-color
  --md-code-hl-color
*/
}

标签页组件♪

YAML
1
2
3
4
markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

链接锚点♪

可以实现分享链接后，自动跳转到所在位置。

YAML
1
2
3
4
5
markdown_extensions:
  - pymdownx.tabbed:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
YAML
 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
site_url: https://catalan1906.github.io
site_name: Catalan1906 的杂货间

theme:
  name: material
  logo: files/icon.jpg
  favicon: files/icon.jpg
  features:
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - search.suggest
    - content.code.copy
    - content.code.select
  icon:
    annotation: material/plus-circle

plugins:
  - search

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - stylesheets/extra.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: ♪
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      linenums: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.smartsymbols
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist: 
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.critic:
      mode: view
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower