-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
99 lines (92 loc) · 3.76 KB
/
mkdocs.yml
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
# [Info]
site_name: Xinyi's Website # 左上角标题
site_url: https://xinyi-xs.github.io
site_author: xinyi
site_description: Xinyi's Website
# [UI]
## [top]
theme:
name: material
palette:
- scheme: default # 日间模式
primary: indigo # 上方的
accent: orange # 链接等可交互元件的高亮色
toggle:
icon: material/weather-night # 图标
name: 切换至夜间模式 # 鼠标悬浮提示
- scheme: slate # 夜间模式
primary: indigo
accent: orange
toggle:
icon: material/weather-sunny
name: 切换至日间模式
features:
- navigation.tabs # 使用Tab来进行分类
- navigation.top # 返回顶部的按钮 在上滑时出现
- navigation.indexes # Tab会有一个index.md 而不是在打开Tab时打开第一篇文章
- navigation.expand # 打开Tab时左侧目录全部展开
- search.suggest # 搜索输入一些字母时推荐补全整个单词
- search.highlight # 搜索出的文章关键词加入高亮
language: zh # 一些提示性的文字会变成中文
icon:
repo: fontawesome/brands/github
edit_uri: edit/main/docs # 编辑按钮跳转的链接
## [top-right corner]
repo_url: https://github.com/lee-emqx/xinyi # 右上角点击跳转的链接
repo_name: xinyi # 右上角的名字
## [bottom-left corner]
copyright: Copyright © 2022 xinyi # 左下角的版权声明
## [bottom-right corner]
extra:
social: # icons
- icon: fontawesome/brands/bilibili
link: https://space.bilibili.com
name: Bilibili | xinyi # 鼠标悬浮提示
- icon: fontawesome/brands/github
link: https://github.com/lee-emqx
name: GitHub | xinyi
# [Navigtion]
nav:
- 技术:
- tech/index.md
- QUIC with cubic or bbr: tech/quic_with_cubic_bbr.md
- 随笔:
- note/index.md
- 打油诗: note/poem.md
- 读书笔记:
- reading/index.md
- 关于:
- about/index.md # 使用两个index 这样子左上角第一次打开会是所有Tab 而不是ABOUT
- 个人履历: about/cv-full.md
- 支持作者: about/support.md
# [Extensions]
plugins:
- search: # 现在还不支持中文搜索 支持之后可以设置语言
# insider已经支持中文的分词搜索了 https://squidfunk.github.io/mkdocs-material/blog/2022/chinese-search-support/
lang:
- en
- ja
- tags # 给单篇文章添加标签 https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/?h=tags
markdown_extensions:
- pymdownx.arithmatex: # latex支持
generic: true
- attr_list # 给图片后面添加{width="300"}设置大小
- toc:
permalink: true # 固定标题位置为当前位置
- pymdownx.highlight: # 代码块高亮
# linenums: true # 显示行号
# auto_title: true # 显示编程语言名称
- pymdownx.superfences # 代码块高亮插件
- meta # 支持Markdown文件上方自定义标题标签等
- admonition # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#inline-blocks
- pymdownx.details # admonition需要
extra_javascript:
# latex支持
# check https://squidfunk.github.io/mkdocs-material/reference/mathjax/?h=math for more information
# notice `curl https://polyfill.io/v3/polyfill.min.js?features=es6 > docs/mkdocs/javascripts/polyfill.min.js && curl https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js > docs/mkdocs/javascripts/tex-mml-chtml.js` not works... because there are other resources that need to load
- mkdocs/javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # https://cdn.bytedance.com/?query=mathjax&version=3.2.0
extra_css:
- mkdocs/css/no-footer.css # 不使用底部的翻页
- mkdocs/css/unordered-list-symbols.css # multiplt unordered list symbols