Skip to content

Commit 2024766

Browse files
Charliechen114514Charliechen114514
committed
fix: mkdocs.yml error
1 parent a9027fe commit 2024766

1 file changed

Lines changed: 209 additions & 1 deletion

File tree

‎mkdocs.yml‎

Lines changed: 209 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,209 @@
1-
site_name: DocHome For CFDesktop # 网站标题,显示在浏览器标签和页面顶部site_description: CFDesktop的文档 # 网站描述,用于SEO优化site_author: CharlieChen # 作者名称,可以改成你的真实姓名或网名# 版权信息,显示在页面底部copyright: Copyright © 2026 CharlieChen - 保留所有权利# 文档源文件夹docs_dir: "document"# ==================== 主题配置 ====================# Material 是一个现代化的 MkDocs 主题,提供了丰富的功能和美观的界面theme: name: material # 使用 Material 主题 language: zh # 界面语言设置为简体中文 # 自定义网站图标和Logo logo: Awesome-Embedded.png # 网站Logo favicon: Awesome-Embedded.ico # 浏览器标签图标 # 调色板配置 - 支持亮色/暗色模式切换 palette: # 亮色模式 - media: "(prefers-color-scheme: light)" scheme: default # 使用默认亮色主题 primary: indigo # 主色调:靛蓝色(导航栏等) accent: indigo # 强调色(链接、按钮等) toggle: icon: material/brightness-7 # 切换图标 name: 切换至暗色模式 # 暗色模式 - media: "(prefers-color-scheme: dark)" scheme: slate # 使用暗色主题 primary: black # 主色调:黑色 accent: indigo # 强调色保持一致 toggle: icon: material/brightness-4 # 切换图标 name: 切换至亮色模式 # 字体配置 font: text: Roboto # 正文字体 code: Roboto Mono # 代码字体 # 功能特性开关 features: # ---------- 导航功能 ---------- - navigation.instant # 即时加载,页面切换更流畅(类似SPA) - navigation.instant.prefetch # 预加载链接,提升访问速度 - navigation.instant.progress # 显示加载进度条 - navigation.tracking # 地址栏自动更新为当前标题的锚点 - navigation.tabs # 顶部显示主要章节标签(适合多章节博客) - navigation.tabs.sticky # 滚动时标签栏保持固定 - navigation.sections # 侧边栏显示章节分组 - navigation.expand # 默认展开所有章节(方便查看全部内容) - navigation.path # 显示当前页面的完整路径 - navigation.indexes # 支持章节索引页 - navigation.top # 显示"返回顶部"按钮 - navigation.footer # 页面底部显示上一页/下一页导航 # ---------- 目录功能 ---------- - toc.follow # 目录自动跟随滚动 - toc.integrate # 将右侧目录集成到左侧导航栏(节省空间) # ---------- 搜索功能 ---------- - search.suggest # 搜索时显示建议 - search.highlight # 高亮显示搜索结果 - search.share # 允许分享搜索结果链接 # ---------- 内容功能 ---------- - content.code.copy # 代码块添加复制按钮 - content.code.select # 代码块可以选择 - content.code.annotate # 代码块支持注释 - content.tabs.link # 内容标签页可以链接 - content.tooltips # 鼠标悬停显示提示信息 - content.action.edit # 显示"编辑此页"按钮 - content.action.view # 显示"查看源代码"按钮# ==================== Markdown 扩展 ====================# 这些扩展增强了 Markdown 的功能,让你能写出更丰富的内容markdown_extensions: # ---------- 基础扩展 ---------- - abbr # 支持缩写定义 - attr_list # 允许为元素添加HTML属性 - def_list # 支持定义列表 - footnotes # 支持脚注 - md_in_html # 允许在HTML中使用Markdown - tables # 表格支持(标准Markdown已支持,这里确保启用) # 目录扩展 - toc: permalink: true # 标题旁显示永久链接符号(#) permalink_title: 链接到此章节 # 永久链接的提示文字 slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower # URL中的标题转为小写 # 警告框扩展 - 可以创建提示、警告、危险等样式的信息框 - admonition # 基础警告框支持 # ---------- PyMdown 扩展(强大的Markdown增强) ---------- # 细节折叠块 - 可折叠的内容区域 - pymdownx.details # 代码高亮 - pymdownx.highlight: anchor_linenums: true # 代码行号可以被链接 line_spans: __span # 每行代码单独包装 pygments_lang_class: true # 添加语言类名 linenums: true # 显示行号 linenums_style: pymdownx-inline # 行号样式 # 行内代码高亮 - pymdownx.inlinehilite # 代码块和其他内容的围栏支持 - pymdownx.superfences: custom_fences: # 支持 Mermaid 图表 - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format # 内容标签页 - 可以创建多个标签切换的内容区域 - pymdownx.tabbed: alternate_style: true # 使用替代样式 combine_header_slug: true # 合并标签头的slug slugify: !!python/object/apply:pymdownx.slugs.slugify kwds: case: lower # Emoji 支持 - 可以使用 :smile: 这样的表情符号 - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg # 其他实用扩展 - pymdownx.caret # 支持上标 ^text^ - pymdownx.mark # 支持高亮标记 ==text== - pymdownx.tilde # 支持删除线 ~~text~~ 和下标 ~text~ - pymdownx.keys # 支持键盘按键显示 ++ctrl+alt+del++ - pymdownx.smartsymbols # 智能符号替换 - pymdownx.snippets # 支持包含其他文件的代码片段 - pymdownx.critic # 支持批注和修订标记 - pymdownx.betterem # 改进的强调语法# ==================== 插件配置 ====================# 插件为网站添加额外功能plugins: # 搜索插件 - 提供全站搜索功能 - search: separator: '[\s\u200b\-_,:!=\[\]()"/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' # 中文分词支持 lang: - zh # 中文搜索 - en # 英文搜索 pipeline: - stemmer - stopWordFilter - trimmer # Awesome Pages 插件 - 灵活的页面组织方式 - awesome-pages # Git 修订日期插件 - 自动显示文章的创建和更新时间 - git-revision-date-localized: enable_creation_date: true # 显示创建日期 fallback_to_build_date: true # 如果Git历史不可用,使用构建日期 type: datetime # 日期格式: datetime(日期+时间) / date(仅日期) / iso_date / iso_datetime timezone: Asia/Shanghai # 时区设置 locale: zh # 本地化语言# ==================== 额外配置 ====================# 社交媒体链接 - 显示在页面右上角extra: # 社交媒体图标 social: - icon: fontawesome/brands/github # GitHub图标 link: https://github.com/Awesome-Embedded-Learning-Studio # 你的GitHub主页 name: GitHub - icon: fontawesome/solid/paper-plane # 邮件图标 link: mailto:725610365@qq.com name: 发送邮件# ==================== 额外的CSS和JavaScript ====================# 可以添加自定义样式和脚本extra_javascript: # 数学公式支持(MathJax) - javascripts/mathjax.js - https://polyfill.io/v3/polyfill.min.js?features=es6 - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js# ==================== 注意事项 ====================# 本地预览命令:# mkdocs serve # 启动本地服务器,访问 http://127.0.0.1:8000## ==================== 配置结束 ====================
1+
site_name: DocHome For CFDesktop # 网站标题,显示在浏览器标签和页面顶部
2+
site_description: CFDesktop的文档 # 网站描述,用于SEO优化
3+
site_author: CharlieChen # 作者名称,可以改成你的真实姓名或网名
4+
5+
# 版权信息,显示在页面底部
6+
copyright: Copyright © 2026 CharlieChen - 保留所有权利
7+
8+
# 文档源文件夹
9+
docs_dir: "document"
10+
11+
12+
# ==================== 主题配置 ====================
13+
# Material 是一个现代化的 MkDocs 主题,提供了丰富的功能和美观的界面
14+
15+
theme:
16+
name: material # 使用 Material 主题
17+
language: zh # 界面语言设置为简体中文
18+
19+
# 自定义网站图标和Logo
20+
logo: Awesome-Embedded.png # 网站Logo
21+
favicon: Awesome-Embedded.ico # 浏览器标签图标
22+
23+
# 调色板配置 - 支持亮色/暗色模式切换
24+
palette:
25+
# 亮色模式
26+
- media: "(prefers-color-scheme: light)"
27+
scheme: default # 使用默认亮色主题
28+
primary: indigo # 主色调:靛蓝色(导航栏等)
29+
accent: indigo # 强调色(链接、按钮等)
30+
toggle:
31+
icon: material/brightness-7 # 切换图标
32+
name: 切换至暗色模式
33+
34+
# 暗色模式
35+
- media: "(prefers-color-scheme: dark)"
36+
scheme: slate # 使用暗色主题
37+
primary: black # 主色调:黑色
38+
accent: indigo # 强调色保持一致
39+
toggle:
40+
icon: material/brightness-4 # 切换图标
41+
name: 切换至亮色模式
42+
43+
# 字体配置
44+
font:
45+
text: Roboto # 正文字体
46+
code: Roboto Mono # 代码字体
47+
48+
# 功能特性开关
49+
features:
50+
# ---------- 导航功能 ----------
51+
- navigation.instant # 即时加载,页面切换更流畅(类似SPA)
52+
- navigation.instant.prefetch # 预加载链接,提升访问速度
53+
- navigation.instant.progress # 显示加载进度条
54+
- navigation.tracking # 地址栏自动更新为当前标题的锚点
55+
- navigation.tabs # 顶部显示主要章节标签(适合多章节博客)
56+
- navigation.tabs.sticky # 滚动时标签栏保持固定
57+
- navigation.sections # 侧边栏显示章节分组
58+
- navigation.expand # 默认展开所有章节(方便查看全部内容)
59+
- navigation.path # 显示当前页面的完整路径
60+
- navigation.indexes # 支持章节索引页
61+
- navigation.top # 显示"返回顶部"按钮
62+
- navigation.footer # 页面底部显示上一页/下一页导航
63+
64+
# ---------- 目录功能 ----------
65+
- toc.follow # 目录自动跟随滚动
66+
- toc.integrate # 将右侧目录集成到左侧导航栏(节省空间)
67+
68+
# ---------- 搜索功能 ----------
69+
- search.suggest # 搜索时显示建议
70+
- search.highlight # 高亮显示搜索结果
71+
- search.share # 允许分享搜索结果链接
72+
73+
# ---------- 内容功能 ----------
74+
- content.code.copy # 代码块添加复制按钮
75+
- content.code.select # 代码块可以选择
76+
- content.code.annotate # 代码块支持注释
77+
- content.tabs.link # 内容标签页可以链接
78+
- content.tooltips # 鼠标悬停显示提示信息
79+
- content.action.edit # 显示"编辑此页"按钮
80+
- content.action.view # 显示"查看源代码"按钮
81+
82+
83+
# ==================== Markdown 扩展 ====================
84+
# 这些扩展增强了 Markdown 的功能,让你能写出更丰富的内容
85+
86+
markdown_extensions:
87+
# ---------- 基础扩展 ----------
88+
- abbr # 支持缩写定义
89+
- attr_list # 允许为元素添加HTML属性
90+
- def_list # 支持定义列表
91+
- footnotes # 支持脚注
92+
- md_in_html # 允许在HTML中使用Markdown
93+
- tables # 表格支持(标准Markdown已支持,这里确保启用)
94+
95+
# 目录扩展
96+
- toc:
97+
permalink: true # 标题旁显示永久链接符号(#)
98+
permalink_title: 链接到此章节 # 永久链接的提示文字
99+
slugify: !!python/object/apply:pymdownx.slugs.slugify
100+
kwds:
101+
case: lower # URL中的标题转为小写
102+
103+
# 警告框扩展 - 可以创建提示、警告、危险等样式的信息框
104+
- admonition # 基础警告框支持
105+
106+
# ---------- PyMdown 扩展(强大的Markdown增强) ----------
107+
108+
# 细节折叠块 - 可折叠的内容区域
109+
- pymdownx.details
110+
111+
# 代码高亮
112+
- pymdownx.highlight:
113+
anchor_linenums: true # 代码行号可以被链接
114+
line_spans: __span # 每行代码单独包装
115+
pygments_lang_class: true # 添加语言类名
116+
linenums: true # 显示行号
117+
linenums_style: pymdownx-inline # 行号样式
118+
119+
# 行内代码高亮
120+
- pymdownx.inlinehilite
121+
122+
# 代码块和其他内容的围栏支持
123+
- pymdownx.superfences:
124+
custom_fences:
125+
# 支持 Mermaid 图表
126+
- name: mermaid
127+
class: mermaid
128+
format: !!python/name:pymdownx.superfences.fence_code_format
129+
130+
# 内容标签页 - 可以创建多个标签切换的内容区域
131+
- pymdownx.tabbed:
132+
alternate_style: true # 使用替代样式
133+
combine_header_slug: true # 合并标签头的slug
134+
slugify: !!python/object/apply:pymdownx.slugs.slugify
135+
kwds:
136+
case: lower
137+
138+
# Emoji 支持 - 可以使用 :smile: 这样的表情符号
139+
- pymdownx.emoji:
140+
emoji_index: !!python/name:material.extensions.emoji.twemoji
141+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
142+
143+
# 其他实用扩展
144+
- pymdownx.caret # 支持上标 ^text^
145+
- pymdownx.mark # 支持高亮标记 ==text==
146+
- pymdownx.tilde # 支持删除线 ~~text~~ 和下标 ~text~
147+
- pymdownx.keys # 支持键盘按键显示 ++ctrl+alt+del++
148+
- pymdownx.smartsymbols # 智能符号替换
149+
- pymdownx.snippets # 支持包含其他文件的代码片段
150+
- pymdownx.critic # 支持批注和修订标记
151+
- pymdownx.betterem # 改进的强调语法
152+
153+
154+
# ==================== 插件配置 ====================
155+
# 插件为网站添加额外功能
156+
157+
plugins:
158+
# 搜索插件 - 提供全站搜索功能
159+
- search:
160+
separator: '[\s\u200b\-_,:!=\[\]()"/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])' # 中文分词支持
161+
lang:
162+
- zh # 中文搜索
163+
- en # 英文搜索
164+
pipeline:
165+
- stemmer
166+
- stopWordFilter
167+
- trimmer
168+
169+
# Awesome Pages 插件 - 灵活的页面组织方式
170+
- awesome-pages
171+
172+
# Git 修订日期插件 - 自动显示文章的创建和更新时间
173+
- git-revision-date-localized:
174+
enable_creation_date: true # 显示创建日期
175+
fallback_to_build_date: true # 如果Git历史不可用,使用构建日期
176+
type: datetime # 日期格式: datetime(日期+时间) / date(仅日期) / iso_date / iso_datetime
177+
timezone: Asia/Shanghai # 时区设置
178+
locale: zh # 本地化语言
179+
180+
181+
# ==================== 额外配置 ====================
182+
183+
# 社交媒体链接 - 显示在页面右上角
184+
extra:
185+
# 社交媒体图标
186+
social:
187+
- icon: fontawesome/brands/github # GitHub图标
188+
link: https://github.com/Awesome-Embedded-Learning-Studio # 你的GitHub主页
189+
name: GitHub
190+
- icon: fontawesome/solid/paper-plane # 邮件图标
191+
link: mailto:725610365@qq.com
192+
name: 发送邮件
193+
194+
195+
# ==================== 额外的CSS和JavaScript ====================
196+
# 可以添加自定义样式和脚本
197+
198+
extra_javascript:
199+
# 数学公式支持(MathJax)
200+
- javascripts/mathjax.js
201+
- https://polyfill.io/v3/polyfill.min.js?features=es6
202+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
203+
204+
205+
# ==================== 注意事项 ====================
206+
# 本地预览命令:
207+
# mkdocs serve # 启动本地服务器,访问 http://127.0.0.1:8000
208+
#
209+
# ==================== 配置结束 ====================

0 commit comments

Comments
 (0)