-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
107 lines (99 loc) · 3.87 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
100
101
102
103
104
105
106
107
# [Info] 基本信息
site_name: 人工智能个人学习博客 # 左上角标题
site_url: https://gis-xh.github.io/AI-study
site_author: gis-xh
site_description: 人工智能个人学习博客
# [UI] 界面设置
## [top]
theme:
name: material
custom_dir: docs/mkdocs/overrides
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:
- content.code.copy # 代码复制
- navigation.tabs # 使用Tab来进行分类
- navigation.top # 返回顶部的按钮 在上滑时出现
- navigation.footer # 上一个下一个按钮
- navigation.indexes # Tab会有一个index.md 而不是在打开Tab时打开第一篇文章
- navigation.expand # 打开Tab时左侧目录全部展开
- search.suggest # 搜索输入一些字母时推荐补全整个单词
- search.highlight # 搜索出的文章关键词加入高亮
- search.share # 将搜索结果分享
language: zh # 一些提示性的文字会变成中文
icon:
repo: fontawesome/brands/github-alt
edit_uri: edit/main/docs # 编辑按钮跳转的链接
## [top-right corner]
repo_url: https://github.com/gis-xh/AI-study # 右上角点击跳转的链接
repo_name: gis-xh/AI-study # 右上角的名字
## [bottom-left corner]
copyright: Copyright © 2023 gis-xh # 左下角的版权声明
## [bottom-right corner]
extra:
social: # icons
- icon: fontawesome/brands/github
link: https://github.com/gis-xh
name: GitHub | gis-xh # 鼠标悬浮提示
# [Navigtion] 导航栏
# nav:
# [Extensions] 扩展
plugins:
- search:
# insider已经支持中文的分词搜索了 https://squidfunk.github.io/mkdocs-material/blog/2022/chinese-search-support/
lang:
- en
- ja
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- tags # 给单篇文章添加标签 https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/?h=tags
- git-revision-date-localized: # 日期显示
# ["date","datetime","iso_date","iso_datetime","timeago","custom"]
type: timeago
enable_creation_date: true # 创建时间
timezone: Asia/Shanghai
- git-authors # 显示作者
- glightbox # 图像缩放
- meta-manager # 元数据管理
markdown_extensions:
- pymdownx.arithmatex: # latex支持
generic: true
- attr_list # 给图片后面添加{width="300"}设置大小
- md_in_html
- tables
- toc:
permalink: true # 固定标题位置为当前位置
- pymdownx.highlight: # 代码块高亮
linenums: false # 显示行号
linenums_style: table
# auto_title: true # 显示编程语言名称
- pymdownx.superfences # 代码块高亮插件
- pymdownx.inlinehilite # 段落中内置的小代码高亮
- admonition # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#inline-blocks
- pymdownx.details # admonition需要
- pymdownx.caret # markdown上标显示
- pymdownx.tilde # markdown下标显示
- pymdownx.mark # markdown突出显示
extra_javascript:
# MathJax 支持
# - mkdocs/js/mathjax.js
# - https://polyfill.io/v3/polyfill.min.js?features=es6
# - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# KaTeX 支持, 轻量级更快速
- mkdocs/js/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- mkdocs/css/unordered-list-symbols.css # 多个无序列表符号
- mkdocs/css/img-center.css # 图像居中
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css