fastapi-amis/mkdocs.yml at main · InfernalAzazel/fastapi-amis · 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
site_name: FastAPI Amis
site_url: https://infernalazazel.github.io/fastapi-amis/
site_description: 基于 FastAPI 和 Amis 的 Python 框架，用于快速构建现代化的管理后台界面
site_author: kylin
repo_url: https://github.com/InfernalAzazel/fastapi-amis
repo_name: fastapi-amis

theme:
  name: material
  language: zh
  palette:
    # 浅色模式
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: 切换至深色模式
    # 深色模式
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: 切换至浅色模式
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search:
      lang:
        - zh
        - en

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

nav:
  - 首页: index.md
  - 快速开始:
      - 安装: getting-started/installation.md
      - 第一个应用: getting-started/first-app.md
      - 示例项目: getting-started/examples.md
  - 用户指南:
      - 核心概念: guide/concepts.md
      - 视图和路由: guide/views-and-routers.md
      - Amis 组件: guide/amis-components.md
      - 站点配置: guide/site-configuration.md
  - API 参考:
      - 核心模块: api/core.md
      - Amis 组件: api/components.md
      - 扩展功能: api/extensions.md
  - 最佳实践:
      - 项目结构: best-practices/project-structure.md
      - 开发建议: best-practices/development.md
  - 贡献指南: contributing.md
  - 更新日志: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/InfernalAzazel/fastapi-amis
  version:
    provider: mike