Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
122 lines (117 loc) · 5.61 KB
/
Copy pathmkdocs.yml
File metadata and controls
122 lines (117 loc) · 5.61 KB
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
site_name: FastApi 最佳实践-中文版
repo_name: FastApi 最佳实践-中文版
repo_url: https://github.com/hellowac/fastapi-best-practices-zh-cn/
site_description: FastApi 最佳实践-中文版
# 配置主题,在mkdocs.yml文件下
theme:
name: material
language: zh
features:
- content.code.copy # 代码支持拷贝
- content.tabs.link # 内容tabs支持
- navigation.tabs # 顶部导航
- navigation.tabs.sticky # 顶部导航粘连
- navigation.indexes # 导航index页面支持
# - navigation.sections # 全部展开(非折叠状态)
# - navigation.expand # 子目录展开
- navigation.top # 返回顶部按钮
- toc.follow # 页面目录支持
# 插件
plugins:
- glightbox
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- git-revision-date-localized: # 支持文档创建时间显示, https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
locale: zh
enable_creation_date: true
type: date
# markdown解析扩展
markdown_extensions:
- tables
- admonition
- attr_list
- footnotes # 引用支持 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes
- def_list # 键-值组合的list https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes
- toc: # 页面目录支持 https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents
permalink: true # 标题锚点支持
slugify:
!!python/object/apply:pymdownx.slugs.slugify # 区分大小写的显示标题
kwds:
case: lower # 全小写支持
- md_in_html # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#footnotes
# pymdownx 扩展,参考:https://facelessuser.github.io/pymdown-extensions/
- pymdownx.inlinehilite # 单行高亮, 参考: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#highlighting-specific-lines
- pymdownx.critic # 支持部分字段格式化,参考:https://squidfunk.github.io/mkdocs-material/reference/formatting/
- pymdownx.highlight # 支持代码块高亮显示
- pymdownx.snippets
- pymdownx.details
- pymdownx.superfences: # 注释 :
# preserve_tabs: true
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed: # 支持内容tab, https://squidfunk.github.io/mkdocs-material/reference/content-tabs/
alternate_style: true
- pymdownx.caret # 下划线, 上标 : https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=caret#caret-mark-tilde
# https://facelessuser.github.io/pymdown-extensions/extensions/caret/
- pymdownx.mark # 标记 :https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=caret#caret-mark-tilde
# https://facelessuser.github.io/pymdown-extensions/extensions/mark/
- pymdownx.tilde # 删除线, 下标 参考: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=caret#caret-mark-tilde
# https://facelessuser.github.io/pymdown-extensions/extensions/tilde/
- pymdownx.arithmatex:
generic: true
# 扩展支持, 支持数学符号
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://unpkg.com/mermaid@9.4.0/dist/mermaid.min.js
# - https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
# 页面导航
nav:
- 最佳实践: index.md
- 英文原版: raw_en.md
- Asyncio:
- 中文简单指南: asyncio/asyncio.md
- 中英对照指南: asyncio/asyncio_en.md
- Runner运行协程: asyncio/runner.md
- TaskGroup管理协程: asyncio/task_group.md
- 语法备忘录: asyncio/cheat_sheet.md
- API思维导图: asyncio/api_mind_map.md
- mypy:
- 类型注解备忘录: mypy/cheat_sheet_py3.md
- 类型系统参考-内置类型: mypy/builtin_types.md
- 类型系统参考-类型推断和类型注解: mypy/type_inference_type_annotations.md
- 类型系统参考-类型种类: mypy/kind_of_types.md
- 类型系统参考-类的基础: mypy/class_basics.md
- 类型系统参考-运行时的注解问题: mypy/annotation_issue_at_runtime.md
- 类型系统参考-协议和结构子类型: mypy/protocol_and_struct_subtyping.md
- 类型系统参考-动态类型: mypy/dynamic_typing.md
- 类型系统参考-类型收缩: mypy/type_narrowing.md
- 类型系统参考-鸭子类型兼容: mypy/duck_type_compatibility.md
- 类型系统参考-存根文件: mypy/stub_files.md
- 类型系统参考-泛型: mypy/generics.md
- 类型系统参考-更多类型: mypy/more_types.md
- 类型系统参考-字面量和枚举: mypy/literal_and_enum.md
- 类型系统参考-类型字典: mypy/typeddict.md
- 类型系统参考-最终名称、方法和类: mypy/final_names_methods_classes.md
- 类型系统参考-元类: mypy/metaclasses.md
- HTTP:
- http/internet_protocol_suite_part_i.md
- http/internet_protocol_suite_part_ii.md
- http/index.md
- http/restapi.md
- http/restapibsetp.md
- http/http-referer.md
- http/https.md
- Git:
- git/git-branch-manage.md
- git/git-remote.md
- git/git-use-process.md
- git/git-cheat-sheet.md
- git/git-work-flow.md
- xml: xml/index.md
- 系统设计:
- sysdesign/perm_design.md
- 关于: about.md