-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
97 lines (91 loc) · 2.48 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
site_name: Pydantic
site_description: 使用Python类型注解进行数据校验
strict: true
site_url: https://hellowac.github.io/pydantic-zh-cn/
theme:
name: "material"
custom_dir: "docs/theme"
language: zh
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: "Switch to light mode"
features:
- content.tabs.link
- navigation.top # 返回顶部按钮
- content.code.copy # 代码支持copy
logo: "logo-white.svg"
favicon: "favicon.png"
repo_name: hellowac/pydantic-zh-cn
repo_url: https://github.com/hellowac/pydantic-zh-cn
edit_uri: edit/main/docs/
extra:
version:
provider: mike
default: stable
extra_css:
- "extra/terminal.css"
- "extra/tweaks.css"
extra_javascript:
- "extra/redirects.js"
nav:
- 概览: index.md
- 安装: install.md
- 使用指南:
- 模型: usage/models.md
- 字段类型: usage/types.md
- 字段校验: usage/validators.md
- 模型配置: usage/model_config.md
- schema: usage/schema.md
- 模型导出: usage/exporting_models.md
- 数据类: usage/dataclasses.md
- 校验装饰器: usage/validation_decorator.md
- 配置管理: usage/settings.md
- 延迟注解: usage/postponed_annotations.md
- 和mypy一起使用: usage/mypy.md
- 和rich一起使用: usage/rich.md
- 和devtools一起使用: usage/devtools.md
- 博客:
- Pydantic V2 版本计划: blog/pydantic-v2.md
- 贡献参与: contributing.md
- Mypy插件: mypy_plugin.md
- PyCharm插件: pycharm_plugin.md
- VSCode使用: visual_studio_code.md
- Hypothesis插件: hypothesis_plugin.md
- 代码生成: datamodel_code_generator.md
- 更新日志: changelog.md
markdown_extensions:
- tables
- markdown_include.include:
base_path: docs
- toc:
permalink: true
- admonition
- pymdownx.highlight
- pymdownx.extra
- mdx_truly_sane_lists
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
- mike
- exclude:
glob:
- _build/*
- build/*
- examples/*
- requirements.txt