sqlalchemy-crud-plus/mkdocs.yml at master · fastapi-practices/sqlalchemy-crud-plus · GitHub

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
site_name: SQLAlchemy CRUD Plus
site_description: 基于 SQLAlchemy 2.0 构建的高级异步 CRUD SDK
site_url: https://fastapi-practices.github.io/sqlalchemy-crud-plus
site_author: FastAPI Practices
repo_name: sqlalchemy-crud-plus
repo_url: https://github.com/fastapi-practices/sqlalchemy-crud-plus

nav:
  - 首页: index.md
  - 安装: installing.md
  - 基础用法:
      - 快速开始: getting-started/quick-start.md
      - CRUD 操作: usage/crud.md
  - 高级用法:
      - 过滤条件: advanced/filter.md
      - 关系查询: advanced/relationship.md
      - 事务控制: advanced/transaction.md
  - API 参考: api/crud-plus.md
  - 更新日志: changelog.md

theme:
  name: material
  language: zh
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.tracking
    - navigation.top
    - search.suggest
    - toc.follow

markdown_extensions:
  - toc:
      permalink: true
  - tables
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            filters: ["!^_"]
            show_root_heading: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fastapi-practices/sqlalchemy-crud-plus
      name: GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/yNN3wTbVAC
      name: Discord

extra_javascript:
- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js

extra_css:
  - "extra/custom.css"

copyright: |
  &copy; 2026 FastAPI Practices