my_notes/mkdocs.yml at main · KkaiFang/my_notes · 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
site_name: fk的博客
site_author: fk
site_description: 这是我的个人博客


site_url: https://KkaiFang.github.io/my_notes/
theme:
  name: material
  custom_dir: docs/overrides
  # font: false
  # logo: assets/images/apple-logo.svg
  logo: https://pica.zhimg.com/80/v2-74ecd899c7c4cc0258930eaff239a21b_1440w.webp
  # https://s1.imagehub.cc/images/2025/01/05/64eafdf8c27f482c7ecb83003d460d6a.webp
  # https://s1.imagehub.cc/images/2024/02/02/91a767e93d1a344e44c69936464c583e.png

  favicon: https://s2.loli.net/2024/04/26/PmRdM9iGnvOJHgu.png
  # https://s1.imagehub.cc/images/2025/05/05/7ff9985e6f5baffe306907df47042787.png
  # https://pic4.zhimg.com/v2-fee2c2622ad68aeed98a8b411a8b272b_1440w.jpg
  # https://s2.loli.net/2024/04/06/yEOZavwMr6kTWhu.png
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: 关闭自动模式
    - media: "(prefers-color-scheme: light)"
      scheme: default # 日间模式
      primary: blue # 主色
      accent: indigo # 强调色
      toggle:
        icon: material/weather-sunny
        name: 切换至夜间模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate # 夜间模式
      primary: black
      accent: indigo
      toggle:
        icon: material/weather-night
        name: 切换至日间模式
  features:
    - announce.dismiss # 可关闭公告栏
    - navigation.instant # 页面无刷新切换
    - navigation.instant.progress # 页面切换进度条
    - navigation.prune # 只渲染可见导航项
    # - header.autohide  # 自动隐藏头部
    # - navigation.prune # 只渲染可见导航项
    - navigation.tracking # 滚动时URL锚点自动更新
    - navigation.tabs # 一级导航显示为顶部Tab
    - navigation.tabs.sticky  # Tab栏吸顶
    - navigation.sections # 侧边栏分组
    - navigation.top # 返回顶部按钮
    - navigation.footer # 页脚显示在侧边栏
    - search.suggest # 搜索建议
    - search.highlight # 搜索高亮
    - search.share # 搜索结果分享
    - toc.follow # 目录跟随滚动
    # - toc.integrate # 目录集成到侧边栏
    - navigation.expand # 默认展开所有目录
    - navigation.indexes # 支持节索引页
    - content.tabs.link # 支持标签页链接
    - content.tooltips # 支持鼠标悬浮提示
    - content.code.copy # 代码块一键复制
    - content.code.select # 代码块一键全选
    - content.code.fold # 代码块折叠
    # - content.action.edit # 编辑按钮
    # - content.action.view # 查看源码按钮
    - content.code.annotate # 代码注释

  language: zh # 一些提示性的文字会变成中文
  icon:
    repo: fontawesome/brands/github #右上角图标
    previous: fontawesome/solid/angle-left
    # top: fontawesome/solid/angles-up
    alternate: fontawesome/solid/language

edit_uri: edit/main/docs # 编辑按钮跳转的链接
repo_url: https://github.com/KkaiFang/my_notes # 右上角点击跳转的链接
repo_name: my_notes # 右上角的名字

copyright: Copyright &copy; 2022~2025 fk # 左下角的版权声明

# [Navigtion]
nav:
  # - 主页: index.md

  - 随笔:
    - 笔记: 20250904.md
    - 测试: 20250904-1.md

  - 开发:
    - develop/index.md  # 开发首页
    -  proxmox虚拟机模板制作: develop/proxmox.md
    - 前端开发:
      - 前端首页: develop/frontend/index.md
      - JavaScript: develop/frontend/js.md
      - CSS: develop/frontend/css.md
    - 后端开发:
      - 后端首页: develop/backend/index.md
      - Python: develop/backend/python.md
      - 数据库: develop/backend/database.md

  - 博客:
    - 博客首页: blog/index.md
    - 文章:
      - 测试评论功能: blog/posts/test1.md
      - 评论测试: blog/posts/test-comment.md
    # 可以添加分类
    # - 技术文章:
    #   - Web开发: blog/tech/web.md
    #   - 工具使用: blog/tech/tools.md
    # - 生活随笔:
    #   - 旅行: blog/life/travel.md
    #   - 学习: blog/life/learning.md

  - 笔记:
    # 可以创建多级分类
    # - 技术笔记:
    #   - 编程语言: notes/programming/index.md
    #   - 框架学习: notes/frameworks/index.md
    # - 学习笔记:
    #   - 课程笔记: notes/courses/index.md
    #   - 读书笔记: notes/books/index.md
    - 笔记首页: notes/index.md  # 先创建一个首页

  - 旅行:
    - 旅行首页: trip/index.md  # 先创建一个首页
    # - 国内游:
    #   - 北京: trip/domestic/beijing.md
    #   - 上海: trip/domestic/shanghai.md
    # - 国外游:
    #   - 日本: trip/international/japan.md
    #   - 泰国: trip/international/thailand.md

  - 股票:
    - 股票首页: stock/index.md  # 先创建一个首页
    # - 投资笔记:
    #   - 技术分析: stock/analysis/technical.md
    #   - 基本面分析: stock/analysis/fundamental.md
    # - 交易记录:
    #   - 2024年: stock/records/2024.md
    #   - 2025年: stock/records/2025.md

  - 友情连接:
    - 朋友: link.md

  - 关于:
    - 关于我: about/about.md
    - 个人经历: about/个人经历.md

  - 留言板: msgboard.md


extra:
  status:
    new: 最近添加
    deprecated: 已弃用

  generator: true  #删除页脚显示“使用 MkDocs 材料制造”
  social:
    - icon: fontawesome/brands/weixin
      link: ""
      name: 微信
    - icon: fontawesome/brands/telegram
      link: ""
      name: Telegram
    - icon: fontawesome/brands/github
      link: ""
      name: Github
    - icon: fontawesome/brands/bilibili
      link: ""
      name: Bilibili
    - icon: fontawesome/solid/blog
      link: https://www.cnblogs.com/codedingzhen
      name: 博客园
    - icon: fontawesome/regular/envelope
      link: mailto:2045907353@qq.com
      name: Email

  # analytics:
  #   provider: google
  #   property: G-29HZMNR0KG  ##如果你 clone 了我的模板，请将这个修改为你的property
  #   # !ENV GOOGLE_ANALYTICS_KEY
  #   feedback:
  #     title: 此页面有帮助吗？
  #     ratings:
  #       - icon: material/thumb-up-outline
  #         name: This page was helpful
  #         data: 1
  #         note: >-
  #           谢谢你的反馈！
  #       - icon: material/thumb-down-outline
  #         name: This page could be improved
  #         data: 0
  #         note: >-
  #           Thanks for your feedback! Help us improve this page by
  #           using our <a href="https://marketingplatform.google.com/about/analytics/" target="_blank" rel="noopener">feedback form</a>.
  # consent:
  #   title: Cookie consent
  #   description: >-
  #     我也使用cookies来识别您的重复访问和偏好来衡量我们文档的有效性以及用户是否找到他们要找的东西。
  #     如果你同意,你可以帮助我们让我们的网站更好

plugins:

  - search:
      separator: '[\s\u200b\-\u3000\u3001\u3002\uFF0C\uFF0E\uFF1F\uFF01\uFF1B]+'
  # - git-revision-date-localized:
  #     enabled: !ENV [CI, false]  # 改为 false 禁用本地渲染
  #     type: iso_date
  #     enable_creation_date: true
  #     fallback_to_build_date: true
  #     exclude:
  #       - index.md
  #       - tag.md
  #       - waline.md
  #       - link.md
  #       - blog/Mkdocs/linktech.md
  #       - "blog/archive/**"
  #       - "blog/category/**"
  # - git-committers:
  #     enabled: !ENV [CI, false]  # 改为 false 禁用本地渲染
  #     repository: Wcowin/Wcowin.github.io
  #     branch: main
  #     exclude:
  #       - index.md
  #       - tag.md
  #       - waline.md
  #       - link.md
  #       - blog/Mkdocs/linktech.md
  - blog:
      post_date_format: full #时间
      draft: true
      draft_if_future_date: true #自动将具有未来日期的帖子标记为草稿
      # post_readtime: true
      post_readtime_words_per_minute: 265  #计算帖子的阅读时间时读者每分钟预计阅读的字数
      post_url_format: "{date}/{slug}"
      # categories_slugify: !!python/object/apply:pymdownx.slugs.slugify
      #   kwds:
      #     case: lower
      # categories_toc: true
      pagination_per_page: 5
      pagination_url_format: "page/{page}"
      # authors_file: "{blog}/.authors.yml"  #作者信息
  - tags
  - document-dates:
      position: bottom            # Display position: top (after title)  bottom (end of document), default: bottom
      type: date               # Date type: date  datetime  timeago, default: date
      locale: zh               # Localization: en zh zh_TW es fr de ar ja ko ru, default: en
      date_format: '%Y-%m-%d'  # Date format strings, e.g., %Y-%m-%d, %b %d, %Y, etc
      time_format: '%H:%M:%S'  # Time format strings (valid only if type=datetime)
      exclude:                 # List of excluded files
        # - index.md
        - blog/posts/*
        # - blog/index.md
        # - about.md         # Exclude all files in private directory, including subdirectories
      show_author: true       # Show author or not, default:java true


markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - def_list
  - footnotes
  # - callouts
  - md_in_html
  - markdown.extensions.abbr # 支持Markdown文件上方自定义标题标签等
  - pymdownx.magiclink
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.betterem
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.smartsymbols
  - pymdownx.tilde

  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
      preserve_tabs: true
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true # 固定标题位置为当前位置
      # baselevel: 2
      # toc_depth: 3  # 控制标题层级深度
  - pymdownx.highlight: # 代码块高亮
      anchor_linenums: true
      linenums: true # 显示行号
      auto_title: true # 显示编程语言名称
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  # - neoteroi.timeline


extra_javascript:
  # 智谱清言翻译系统
  # - javascripts/glm-config.js
  # - javascripts/glm-translate.js
  # - javascripts/translate-config.js
  # - javascripts/highlight-search.js
  # - docs/javascripts/translate.js
  # - https://cdn.staticfile.net/translate.js/3.12.0/translate.js
  # - javascripts/unified-instant-handler.js  # 统一的即时导航处理器
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/unified-instant-handler.js
  # - javascripts/optimize.js
  # - javascripts/instant-handler.js
  # 延迟加载非关键脚本
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/extra.js  # extra的cdn
  # - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/javascripts/view.js
  # - javascripts/liquid-glass-toc.js  # Liquid Glass TOC 增强效果
  # - javascripts/font-loader.js


extra_css:
  # - stylesheets/highlight-search.css
  - stylesheets/extra.css
  - stylesheets/extra2.css
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/extra.css
  # - stylesheets/link.css  #友链
  # - stylesheets/optimize.css
  # - stylesheets/poem.css
  # - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/poem.css
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/link.css  #友链
  # - stylesheets/card2.css
  # - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/card2.css
  # - stylesheets/customize.css  #按钮圆角化
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/customize.css  #按钮圆角化
  # - stylesheets/flink.css
  # - stylesheets/bannerSlider.css
  # - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/extra.css # extra.css的CDN
  # - stylesheets/extra1.css
  # - stylesheets/video.css
  # - https://unpkg.com/@waline/client@v2/dist/waline.css
  # - https://cdn.jsdelivr.net/npm/gitalk@latest/dist/gitalk.css #评论
  # - ckplayer/css/ckplayer.css
  # - https://cdnjs.cloudflare.com/ajax/libs/social-share.js/1.0.16/css/share.min.css
  # - https://cdn.jsdelivr.net/npm/lxgw-wenkai-webfont@1.1.0/style.css  #字体
  # - https://static.zeoseven.com/zsft/292/main/result.css #字体
  # - stylesheets/ziti.css  #字体
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/ziti.css #字体
  # - https://fontsapi.zeoseven.com/292/main/result.css
  # - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/ziti.css?display=swap
  # - https://chinese-fonts-cdn.deno.COMMENT_DIRECTORIES = ['blog/', 'develop/','trip/','relax/']/packages/lxgwwenkai/dist/LXGWWenKai-Bold/result.css
  # - https://cdn.staticfile.org/font-awesome/4.7.0/css/font-awesome.css # font-awesome表情支持
  # - stylesheets/timeline.css
  # - stylesheets/LiquidGlass.css
  # - about/sty/portfolio.css
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/about/sty/portfolio.css
  - https://cdn.jsdelivr.net/gh/Wcowin/Wcowin.github.io@main/docs/stylesheets/poem.css

watch: #监听文件变动自动刷新
  - docs
  - mkdocs.yml
  - docs/overrides

hooks:
  # - docs/overrides/hooks/socialmedia.py
  - docs/overrides/hooks/reading_time.py
  # - docs/overrides/hooks/ai_summary.py  # 添加AI摘要hook
  - docs/overrides/hooks/related_posts.py
  # - docs/overrides/hooks/toc_optimizer.py
  # - docs/overrides/hooks/last_updated.py
  # - docs/overrides/hooks/reading_progress.py
  - docs/overrides/hooks/comments.py       # 新添加的文章页面评论系统
  # - docs/hook-sqlite-js/plugin.py