mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Datus Docs
site_url: !ENV [DOCS_SITE_URL, "https://docs.datus.ai/"]
copyright: "© 2025 Datus AI"
nav:
  - Home:
    - Overview: index.md
    - Getting Started:
      - Quickstart: getting_started/Quickstart.md
      - Data Engineering Quickstart: getting_started/data_engineering_quickstart.md
      - Contextual Data Engineering: getting_started/contextual_data_engineering.md
      - Dashboard Copilot: getting_started/dashboard_copilot.md
    - CLI:
      - Introduction: cli/introduction.md
      - Chat Command: cli/chat_command.md
      - Context Command: cli/context_command.md
      - Execution Command: cli/execution_command.md
      - MCP Extensions: cli/mcp_extensions.md
      - SQL Execution: cli/sql_execution.md
      - Skill Command: cli/skill_command.md
      - Package Command: cli/package_command.md
      - Reference: cli/reference.md
      - Plan Mode: cli/plan_mode.md
      - Other Commands: cli/other_commands.md
    - Subagent:
      - Introduction: subagent/introduction.md
      - Built-in subagents: subagent/builtin_subagents.md
      - Customized subagents: subagent/customized_subagent.md
      - Semantic Modeling: subagent/semantic_modeling.md
      - Ask Metrics: subagent/ask_metrics.md
      - Generate SQL Summary: subagent/gen_sql_summary.md
      - Table Generation: subagent/gen_table.md
      - Data Pipeline (ETL + Migration): subagent/gen_job.md
      - HTML Report Generation: subagent/gen_visual_report.md
      - HTML Dashboard Generation: subagent/gen_visual_dashboard.md
    - Skills:
      - Introduction: skills/introduction.md
      - Built-in Skills:
        - Init: skills/init.md
        - Build KB: skills/build_kb.md
        - Dashboard Bootstrap: skills/dashboard_bootstrap.md
        - Storage Classify: skills/storage_classify.md
        - Extract Knowledge: skills/extract_knowledge.md
        - Memory Organization: skills/memory_organization.md
        - Session Summarize: skills/session_summarize.md
    - Plugin:
      - Introduction: plugin/introduction.md
      - Development: plugin/development.md
    - Chatbot: web_chatbot/introduction.md
    - IM Gateway:
      - Introduction: gateway/introduction.md
      - Slack: gateway/slack.md
      - Feishu: gateway/feishu.md
    - Knowledge Base:
      - Introduction: knowledge_base/introduction.md
      - Platform Documentation: knowledge_base/platform_doc.md
      - Metadata: knowledge_base/metadata.md
      - Metadata Full-text Search: knowledge_base/metadata_fts.md
      - Semantic Models: knowledge_base/semantic_model.md
      - Metrics: knowledge_base/metrics.md
      - Reference SQL: knowledge_base/reference_sql.md
      - Reference Template: knowledge_base/reference_template.md
    - Workflow:
      - Introduction: workflow/introduction.md
      - Nodes: workflow/nodes.md
      - Orchestration: workflow/orchestration.md
      - API: workflow/api.md
    - REST API:
      - Introduction: API/introduction.md
      - Deployment: API/deployment.md
      - Chat: API/chat.md
      - Knowledge Base API: API/knowledge_base.md
      - Debugging: API/debugging.md
    - Configuration:
      - Introduction: configuration/introduction.md
      - Agent: configuration/agent.md
      - Context Compaction: configuration/compact.md
      - Workflow: configuration/workflow.md
      - Benchmark: configuration/benchmark.md
      - SQL Policy: configuration/sql_policy.md
      - Web Tools: configuration/web_tool.md
      - Services:
        - Datasources: configuration/datasources.md
        - Semantic Layer: configuration/semantic_layer.md
        - BI Platforms: configuration/bi_platforms.md
        - Schedulers: configuration/schedulers.md
      - Storage: configuration/storage.md
      - Nodes: configuration/nodes.md
    - Adapters:
      - Database Adapters: adapters/db_adapters.md
      - Semantic Adapters:
        - Overview: adapters/semantic_adapters.md
        - MetricFlow Semantic Adapter: adapters/metricflow_semantic_adapter.md
        - OSI Semantic Adapter: adapters/osi_semantic_adapter.md
        - Dosi Semantic Adapter: adapters/dosi_semantic_adapter.md
      - BI Adapters: adapters/bi_adapters.md
      - Scheduler Adapters: adapters/scheduler_adapters.md
    - Benchmark:
      - Introduction: benchmark/benchmark_manual.md
    - Integration:
      - MCP: integration/mcp.md
      - Validation: integration/validation.md
      - Auto Memory: integration/memory.md
    - Training:
      - LLM Trace Usage: training/llm_trace_usage.md
    - Develop:
      - Overview: develop/README.md
      - Observability: develop/observability.md
    - VSCode Extension: vscode_extension/introduction.md

  - Release Notes: release_notes.md

plugins:
  - search:
      lang: !ENV [DOCS_LOCALE, "en"]
  - mike:
      alias_type: redirect
  - i18n:
      build_only_locale: !ENV [DOCS_LOCALE, "en"]
      fallback_to_default: false
      languages:
        - locale: en
          name: English
          default: true
        - locale: zh
          name: "中文"
          nav_translations:
            Home: 首页
            Overview: 概览
            Getting Started: 入门指南
            Quickstart: 快速开始
            Data Engineering Quickstart: 数据工程快速开始
            Contextual Data Engineering: 上下文数据工程
            Dashboard Copilot: Dashboard Copilot
            CLI: 命令行
            Introduction: 介绍
            Chat Command: 聊天命令
            Context Command: 上下文命令
            Execution Command: 执行命令
            MCP Extensions: MCP 扩展
            SQL Execution: SQL 执行
            Skill Command: 技能命令
            Package Command: 打包命令
            Reference: 参考
            Plan Mode: 计划模式
            Other Commands: 其他命令
            Subagent: Subagent
            Built-in subagents: 内置 subagent
            Customized subagents: 自定义 subagent
            Generate Metrics: 生成指标
            Ask Metrics: 指标问答
            Generate Semantic Model: 生成语义模型
            Chatbot: chatbot
            IM Gateway: IM 网关
            Slack: Slack
            Feishu: 飞书

            Knowledge Base: 知识库
            Platform Documentation: 平台文档
            Metadata: 元数据
            Metadata Full-text Search: 元数据全文检索
            Semantic Models: 语义模型
            Metrics: 指标
            Reference SQL: Reference SQL
            Reference Template: SQL模板
            Workflow: 工作流
            Nodes: 节点
            Orchestration: 编排
            API: API
            REST API: REST API
            Deployment: 部署
            Chat: Chat
            Knowledge Base API: 知识库 API
            Configuration: 配置
            Context Compaction: 上下文压缩
            Services: 服务
            Databases: 数据库
            Semantic Layer: 语义层
            BI Platforms: BI 平台
            Schedulers: 调度器
            Adapters: 适配器
            Database Adapters: 数据库适配器
            Semantic Adapters: 语义层适配器
            MetricFlow Semantic Adapter: MetricFlow 语义适配器
            OSI Semantic Adapter: OSI 语义适配器
            BI Adapters: BI 适配器
            Scheduler Adapters: Scheduler 适配器
            Benchmark: 基准测试
            SQL Policy: SQL Policy
            Integration: 集成
            MCP: MCP
            Skills: Skills
            Built-in Skills: 内置 Skills
            Init: 初始化
            Build KB: 构建知识库
            Storage Classify: 存储分类
            Extract Knowledge: 知识提取
            Memory Organization: 记忆整理
            Session Summarize: 会话总结
            Validation: 校验
            Auto Memory: 自动记忆
            Plugin: 插件
            Development: 开发指南
            Develop: 开发
            Observability: 可观测性
            VSCode Extension: VSCode 插件
            Release Notes: 发布说明

theme:
  name: material
  language: en
  font: false
  logo: assets/logo-light.png
  favicon: assets/logo-light.png
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.footer
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.tracking
    - navigation.indexes
    - content.code.copy
    - content.code.select
    - content.action.edit
    # - header.autohide
repo_name: Datus-ai/Datus-agent
repo_url: https://github.com/Datus-ai/Datus-agent
edit_uri: !ENV [DOCS_EDIT_URI, "edit/main/docs/"]

extra:
  version:
    provider: mike
  # GA4 is loaded via docs/javascripts/analytics.js instead of the built-in
  # Material analytics, so it only fires on docs.datus.ai (excludes localhost /
  # 127.0.0.1 / *.github.io developer & preview traffic).
  # analytics:
  #   provider: google
  #   property: G-8HMXHZDV7F

  alternate:
    - name: English
      link: !ENV [DOCS_EN_BASE, "/"]
      lang: en
    - name: 中文
      link: !ENV [DOCS_ZH_BASE, "/zh/"]
      lang: zh

  social:
    - icon: material/web
      link: https://www.datus.ai
    - icon: fontawesome/brands/github
      link: https://github.com/Datus-ai/Datus-agent
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/datus-ai/shared_invite/zt-3g6h4fsdg-iOl5uNoz6A4GOc4xKKWUYg
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/datusai



markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      # `underscore` keeps smart emphasis for _ / __ but makes * / ** classic,
      # so `**bold**` renders even when flanked by CJK characters (no spaces).
      smart_enable: underscore
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Datus-ai
      repo: Datus-agent
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - 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
  - pymdownx.tilde

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/analytics.js