HEMY NOTES BOOKS ¶
https://hemy08.github.io/hemynotes/
pages_config.json 参考
版权声明¶
如非特别声明，所有博文都使用以下许可：
网站直达¶
站内连接¶
https://www.jsdelivr.com/globalping
一、配置pages_config.json¶
这个是自定义的配置文件，在python脚本中会读取，文件名不可更改。
注意文件必须是UTF-8编码的。
1) site_name¶
网站名称，可以中文或者英文。这个是显示在文档的上方的。
2) site_description¶
网站描述，当鼠标停留在图标上的时候，会显示出来。
3) repo_url¶
pages仓库地址，这个在文档右上方显示，是个按钮，鼠标点击可以跳转到仓库。
4) copyright¶
copyright声明，这个是显示在网页的左下方的。
5) ignore_dirs¶
忽略的文件夹列表，多个目录以英文的分号（“;”）分隔。目的是在生成mkdocs.yml时，忽略对应的文件夹。
这里要写文件夹的全名。
这里列表配置的文件夹，在生成mkdocs.yml文件时，不会生成在nav中。即不在网站上显示。
6) ignore_file_types¶
要忽略的文件类型，这里是文件后缀，多个类型以英文的分号（“;”）分隔。
在生成mkdocs.yml文件时，遇到这里后缀的文件，会跳过，不会生成在nav中。
7) ignore_files¶
要忽略的文件，这里是文件全名，多个文件以英文的分号（“;”）分隔。
这里列表配置的文件，在生成mkdocs.yml文件时，会跳过，不会生成在nav中。
8) chapter infos¶
配置章节信息，当前仅包含相对路径，仓库地址以及子文档根目录，相对路径不可重复
生成的mkdoc.yml会以这里定义的章节顺序，生成nav信息。这里的路径是mkdocs.yml的同级路径。
9）file name convert¶
这里配置文件名的转换列表。
注意文件必须是UTF-8编码的。
有些文件名、文件夹名称在本地会比较长。这样的名称在生成mkdocs.yml时，如果不做特殊处理，显示出来的文件名会很长，不是很美观。
这个配置文件就是专门干这个事情的，把长文件名转换为短文件名。
如图这种的文件名，我们可以配置转换成短文件名，这样在网页上显示就不会换行了。
10) external links¶
外部链接，这里是与本地文件作为导航一起显示在导航栏的，所以不建议设置太多。
如图，这俩再本仓库实际是不存在的
11）extra social¶
友情链接，配置的时候，注意图标的使用。
可以去https://fontawesome.com/icons上进行查询
12) mkdocs配置 theme、plugins、extra、extra_css、extra_javascript、markdown_extensions¶
这些都是mkdocs的主题配置。
theme 是配置主题名称，主题的图标、特性等
plugins 是mkdocs插件配置
extra 是扩展配置
extra_css 是扩展css样式配置，可以配置一些mkdocs的样式，比如标题颜色、字体等，网页宽度
extra_javascript 扩展js脚本，比如配置支持mermaid
markdown_extensions markdown扩展配置，比如支持emoji、mermaid
如果实在不会，可以参考本案例实现。
二、pages_config.json 参考¶
pages_config.json 参考
JSON 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
{
"site name": "HEMY MOTES",
"site description": "HEMY's Personal Notes",
"copyright": "Copyright © 2021-2029 HEMY08",
"HOME": "https://hemy08.github.io/hemynotes/",
"repo url": "https://github.com/hemy08/hemynotes",
"ignore dirs": ".git;.idea;.vscode;images;image;resource;.gitignore;.obsidian;public_resources;figures;public_sys-resources;themes;docs;site;vx_notebook;document;logo",
"ignore file types": ".git;.png;.gif;.txt;.yml;.yaml;.json",
"ignore files": "Contents.md;SUMMARY.md;vx.json;.gitignore",
"chapter infos": {
"Windows": "\\docs\\Windows"
},
"file name convert": {
"Windows": "Windows"
},
"external links": {
"百度": "https://www.baidu.com"
},
"theme": {
"favicon": "themes/images/lvye.png",
"feature": {
"tabs": "true"
},
"features": [
"navigation.tracking",
"navigation.tabs",
"navigation.indexes",
"navigation.prune",
"navigation.top",
"toc.follow",
"header.autohide",
"search.share",
"search.suggest",
"search.highlight"
],
"icon": {
"logo": "material/library",
"admonition": {
"note": "octicons/tag-16",
"abstract": "octicons/checklist-16",
"info": "octicons/info-16",
"tip": "octicons/squirrel-16",
"success": "octicons/check-16",
"question": "octicons/question-16",
"warning": "octicons/alert-16",
"failure": "octicons/x-circle-16",
"danger": "octicons/zap-16",
"bug": "octicons/bug-16",
"example": "octicons/beaker-16",
"quote": "octicons/quote-16"
}
},
"language": "zh",
"name": "material",
"palette": {
"scheme": "default"
}
},
"plugins": {
"search": {
"lang": [
"en",
"ru",
"zh",
"ja"
],
"separator": "[\\s\\u200b\\-]"
}
},
"extra": {
"generator": false,
"search": {
"language": "en, jp, zh"
},
"social": [
{
"icon": "fontawesome/solid/chalkboard",
"link": "https://www.w3cschool.cn/",
"name": "编程狮W3C"
},
{
"icon": "fontawesome/solid/dove",
"link": "https://www.runoob.com/",
"name": "菜鸟教程"
},
{
"icon": "fontawesome/solid/laptop-code",
"link": "https://leetcode.cn/",
"name": "力扣"
},
{
"icon": "fontawesome/solid/file-code",
"link": "http://www.verysource.com/",
"name": "源码查询"
},
{
"icon": "fontawesome/solid/toolbox",
"link": "https://c.runoob.com/",
"name": "菜鸟工具"
},
{
"icon": "fontawesome/solid/pen-nib",
"link": "https://hdesign.ucd.huawei.com/assemble/designcloud",
"name": "DesignCloud"
},
{
"icon": "fontawesome/solid/at",
"link": "mailto:<zhaojunwei008@yeah.net>",
"name": "Email"
}
]
},
"extra_css": [
"themes/css/custom.css",
"themes/css/simpleLightbox.min.css",
"themes/css/pied_piper.css",
"https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css"
],
"extra_javascript": [
"themes/js/custom.js",
"themes/js/simpleLightbox.min.js",
"themes/js/optionalConfig.js",
"themes/js/mermaidloader.js",
"themes/js/umlconvert.js",
"themes/js/mathjax.js",
"themes/js/katex.js",
"https://unpkg.com/mermaid@10.0.2/dist/mermaid.esm.min.mjs",
"https://cdnjs.cloudflare.com/ajax/libs/flowchart/1.17.1/flowchart.min.js",
"https://cdnjs.cloudflare.com/ajax/libs/raphael/2.3.0/raphael.min.js",
"https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.13.6/underscore-min.js",
"https://unpkg.com/@mermaid-js/mermaid-mindmap@9.3.0/dist/mermaid-mindmap.esm.min.mjs",
"https://unpkg.com/@markspec/markdown-it-plantuml@1.1.4/index.js",
"https://cdnjs.cloudflare.com/ajax/libs/webfont/1.6.28/webfontloader.js",
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-mml-chtml.js",
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-chtml.js",
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-chtml-full.js",
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/3.2.0/es5/tex-svg-full.js",
"https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js",
"https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js"
],
"markdown_extensions": [
"admonition",
"footnotes",
"meta",
"def_list",
"pymdownx.caret",
"pymdownx.critic",
"pymdownx.details",
"pymdownx.snippets",
"tables",
"pymdownx.mark",
"pymdownx.inlinehilite",
"pymdownx.smartsymbols",
"pymdownx.tilde",
"attr_list",
"md_in_html",
{
"pymdownx.arithmatex": {
"generic": true
}
},
{
"pymdownx.emoji": {
"emoji_generator": "!!python/name:materialx.emoji.to_svg",
"emoji_index": "!!python/name:materialx.emoji.twemoji"
}
},
{
"pymdownx.highlight": {
"anchor_linenums": true,
"line_spans": "__span",
"pygments_lang_class": true,
"linenums": true,
"auto_title": true
}
},
{
"pymdownx.magiclink": {
"repo_url_shorthand": true,
"user": "squidfunk",
"repo": "mkdocs-material"
}
},
{
"pymdownx.tabbed": {
"alternate_style": true
}
},
{
"pymdownx.tasklist": {
"custom_checkbox": true
}
},
{
"codehilite": {
"guess_lang": false,
"linenums": false
}
},
{
"toc": {
"permalink": true
}
},
{
"pymdownx.betterem": {
"smart_enable": "all"
}
},
{
"pymdownx.emoji": {
"emoji_generator": "!!python/name:pymdownx.emoji.to_png"
}
},
{
"pymdownx.superfences": {
"custom_fences": [
{
"name": "mermaid",
"class": "mermaid",
"format": "!!python/name:pymdownx.superfences.fence_code_format"
},
{
"name": "uml-flowchart",
"class": "flow",
"format": "!!python/name:pymdownx.superfences.fence_code_format"
},
{
"name": "sequence",
"class": "sequence",
"format": "!!python/name:pymdownx.superfences.fence_code_format"
}
],
"preserve_tabs": true
}
}
]
}