masterAllen.github.io/mkdocs-web.yml at main · masterAllen/masterAllen.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
# 项目信息
site_name: Allen Hong's Notes
site_url: https://masterallen.github.io
site_author: Allen Hong
site_description: >-
  Welcome to Allen Hong's Notes. This site records some of my notes. Hope it can help you a bit. You're also welcome to discuss with me and help point out some of this site's issues.

# 代码仓库信息
repo_name: My Github Link # 仓库名称
repo_url: https://github.com/masterAllen # 仓库地址

# 版权信息
copyright: Copyright &copy; 2024 ~ now | 🚀 HONG Anlun (allen hong)

# 配置
theme:
  # variant: classic
  name: material
  custom_dir: overrides
  # logo: static/images/logo.jpg # logo 图片
  language: en # 默认语言
  features: # 功能
    # - navigation.instant # 瞬间加载 - 如果这个开着，那么语言切换后就会跳转至首页，所以我关掉了
    # - navigation.expand # 导航栏默认全部展开，这个肯定不合适
    # - navigation.sections # 导航栏的 section
    # - navigation.tabs.sticky # tab 始终可见
    # - navigation.prune # 只构建可见的页面
    # - navigation.top # 开启顶部导航栏
    - navigation.tabs # 顶级索引被作为 tab
    - navigation.path  # sponsor only，但是很有用
    - navigation.indexes # 点击 section 显示 readme，而不是 readme 是 section 下面单独一篇文章
    - header.autohide # 下滑时会把 header 隐藏起来
    - navigation.footer # 底部导航栏
    # - announce.dismiss # 可以叉掉公告的功能

  palette:
    primary: teal

validation: false

# pip install mkdocs-open-in-new-tab
# Plugins
plugins:
  # 生成在线网站时候不要注释
  - exclude:
      regex:
        # - '.*asset/\.md$'
        # - '.*asset.*\.md$'

  - search
  - open-in-new-tab
#   - rss:
#       match_path: blog/posts/.*
#       date_from_meta:
#         as_creation: date
#       categories:
#         - categories
#         - tags

# 扩展
markdown_extensions:
  - abbr
  - nl2br
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.magiclink
  - pymdownx.smartsymbols
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/copy.js
  - javascripts/collapsible-headings.js
  - javascripts/resizable-sidebar.js
  - javascripts/sidebar-toggle-buttons.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  # - javascripts/mathjax.js
  - 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:
  - stylesheets/extra.css
  - https://unpkg.com/katex@0/dist/katex.min.css

extra:
  analytics:
    provider: google
    property: G-WSXPFTNRTD
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks! You can leave some advices in the comment section below.
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-

nav:
  - Main