aloha-python/doc/mkdocs.zh.yml at main · LabNow-ai/aloha-python · 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
site_name: Aloha Python 微服务工具库
site_description: 开源 Python 工具库与微服务模板，提供 HOCON 配置、结构化日志、数据库集成、加密工具、FastAPI 和 Docker 开发环境。
repo_url: https://github.com/LabNow-ai/aloha-python
edit_uri: blob/main/doc/zh/
site_url: !ENV READTHEDOCS_CANONICAL_URL
docs_dir: ./zh
theme:
  name: material
  language: zh
  highlightjs: true
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.top
    - toc.integrate
    - content.tabs.link
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: blues
      toggle:
        icon: material/brightness-7
        name: 切换到暗色模式
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: 切换到亮色模式
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - toc:
      permalink: true
  - markdown_include.include:
      base_path: .
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
  - 介绍: "index.md"
  - 快速开始: "README-get-start.md"
  - CLI 命令: "README-cli.md"
  - 配置说明: "README-config.md"
  - 12-Factor 落地指南: "README-12factor.md"
  - 开发文档: "README-develop.md"
  - API 参考:
      - 概览: "api/index.md"
      - 核心与配置: "api/core.md"
      - 日志: "api/logging.md"
      - 命令行脚本: "api/scripts.md"
      - 服务层: "api/service.md"
      - 加密: "api/encrypt.md"
      - 数据库: "api/db.md"
      - 工具函数: "api/util.md"
      - 测试工具: "api/testing.md"