mkdocs.yml 4.08 KB
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
  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: 切换到浅色模式

# CJK 搜索:分隔符包含词边界和 CJK 标点。
# 需要时由目录生成器处理真正的中文分词。
plugins:
  - search:
      separator: '[\s\-,;:!=\[\]()"`/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\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
  - 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
      - "运行时: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
      - "Activiti 集成": reference/maintainer/activiti.md
  - 5. 自动目录:
      - auto-catalog/index.md
      - 数据表: auto-catalog/tables/index.md
      - 视图: auto-catalog/views/index.md
      - 存储过程: auto-catalog/procedures/index.md
      - 函数: auto-catalog/functions/index.md
  - 6. 术语表: glossary.md
  - 7. 参与维护: contributing.md

extra:
  generator: false

# Strict mode stays off because many generated stubs are intentionally sparse.
strict: false