mkdocs.yml
5.21 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
site_name: xly（小羚羊）ERP — 框架 Wiki
site_description: 面向开发者和模块配置人员的 xly 印刷行业 ERP 框架 Wiki。
site_url: ""
use_directory_urls: true
docs_dir: docs
site_dir: ../site/zh
theme:
name: material
custom_dir: ../overrides
language: zh
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: 切换到深色模式
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: 切换到浅色模式
# 搜索分隔符：空白、常见标点、点号、HTML 实体和 CJK 标点。
# 已移除 CamelCase 拆分，避免 `BusinessBaseServiceImpl` 或 `MyBatis`
# 被切成多个普通词，导致精确代码标识符搜索被大量噪声淹没。
# 如需部分 token 搜索，lunr 支持后缀通配符（例如 `Service*`）。
# 真正的中文分词仍由目录生成器在索引阶段调用 jieba 处理。
plugins:
- search:
separator: '[\s\-,;:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|[\u3000-\u303f\uff00-\uffef]'
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 4
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
nav:
- 首页: index.md
- 1. 心智模型:
- concepts/index.md
- 数据驱动的基本论点: concepts/thesis.md
- 模块、表单、虚拟表: concepts/modules-forms-vtables.md
- 主从单据模式: concepts/master-slave.md
- "无物理外键、语义外键的现实": concepts/semantic-fk.md
- 两条定制通道: concepts/customization-channels.md
- 定制层级: concepts/customization-layers.md
- 多租户与产品版本: concepts/multi-tenancy.md
- 元数据驱动的请求生命周期: concepts/request-lifecycle.md
- 三层 API: concepts/api-surface.md
- 2. 垂直切片:
- slices/index.md
- "切片 1：CRUD 模块（Hello World）": slices/01-hello-world.md
- "切片 2：多租户与产品版本": slices/02-multi-tenancy.md
- "切片 3：带报表的模块": slices/03-report.md
- "切片 4：扩展一个自定义字段": slices/04-custom-field.md
- "切片 5：扩展每客户 SQL 覆盖": slices/05-customer-sql-override.md
- "切片 6：硬件集成模块（xlyPlc）": slices/06-hardware.md
- "切片 7（暂缓）：带工作流的模块": slices/07-workflow.md
- 3. 参考（配置人员）:
- reference/builder/index.md
- "如何定义表单": reference/builder/define-form.md
- "如何定义虚拟表": reference/builder/define-vtable.md
- "如何挂接工作流": reference/builder/attach-workflow.md
- "如何设置权限": reference/builder/permissions.md
- 4. 参考（维护人员）:
- reference/maintainer/index.md
- "本地运行 xlyEntry": reference/maintainer/running-locally.md
- "技术栈": reference/maintainer/tech-stack.md
- "运行时：BusinessBaseController 及相关组件": reference/maintainer/runtime.md
- "通用存储过程分发": reference/maintainer/proc-dispatch.md
- "元数据变更后的缓存失效": reference/maintainer/cache-invalidation.md
- "SQL 模板（xlyEntry/templesql/）": reference/maintainer/sql-templates.md
- "多服务部署": reference/maintainer/deployment.md
- "元数据管理服务（xlyManage）": reference/maintainer/management-services.md
- "BI / KPI / 图表引擎": reference/maintainer/bi-engine.md
- "Activiti 集成": reference/maintainer/activiti.md
- 5. API 参考:
- api-reference/index.md
- "内部 API（xlyEntry）": api-reference/internal.md
- "外部 API（xlyApi）": api-reference/external.md
- "入站 Webhook（xlyInterface）": api-reference/webhooks.md
- "消息（ActiveMQ / RocketMQ）": api-reference/messaging.md
- "通知（xlyMsg）": api-reference/notifications.md
- 6. 自动目录:
- auto-catalog/index.md
- 数据表: auto-catalog/tables/index.md
- 视图: auto-catalog/views/index.md
- 存储过程: auto-catalog/procedures/index.md
- 函数: auto-catalog/functions/index.md
- 7. 术语表:
- glossary/index.md
- 8. 参与维护:
- contributing/index.md
extra:
alternate:
- name: English
link: /en/
lang: en
- name: 简体中文
link: /zh/
lang: zh
generator: false
# Strict mode stays off because many generated stubs are intentionally sparse.
strict: false