mkdocs.yml

site_name: ChatTool 文档
site_url: https://chattool.wzhecnu.cn
repo_url: https://github.com/CubeNLP/ChatTool
repo_name: ChatTool
edit_uri: edit/master/docs/

theme:
  name: material
  palette:
    primary: teal
    accent: purple
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.sections
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

plugins:
  - search:
      lang: zh
  - minify:
      minify_html: true
  # awesome-pages 暂时禁用，与子目录 index 页面存在冲突
  # - awesome-pages
  - redirects:
      redirect_maps:
        'setup/docker.md': 'env/docker.md'
        'setup/index.md': 'env/index.md'
        'setup/chrome.md': 'env/chrome.md'
        'setup/codex.md': 'env/codex.md'
        'setup/lark-cli.md': 'env/lark-cli.md'
        'setup/frp.md': 'env/frp.md'
        'setup/nginx_proxy.md': 'env/nginx_proxy.md'
        'design/index.md': 'development-guide/index.md'
        'design/directory-responsibilities.md': 'development-guide/directory-responsibilities.md'
        'design/feishu/index.md': 'design/feishu-cli.md'
  # i18n 插件暂时禁用，启用后会导致子目录页面无限刷新，待排查
  # - i18n:
  #     docs_structure: suffix
  #     fallback_to_default: true
  #     reconfigure_material: false
  #     reconfigure_search: true
  #     languages:
  #       - locale: zh
  #         default: true
  #         name: 简体中文
  #         build: true
  #       - locale: en
  #         name: English
  #         build: true

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: friendly
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - def_list
  - attr_list
  - md_in_html

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

extra_css:
  - assets/css/admonition-custom.css
  - assets/css/custom.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css

extra:
  version:
    provider: mike
    default: latest
    alias: true

nav:
  - 主页:
    - 快速开始: index.md
    - CLI 树: cli-tree.md

  - 模型能力:
    - 客户端指南: client.md
    - Chat 对象: chat.md

  - 环境变量:
    - 概览: configuration.md

  - 工具箱:
    - 概览: tools/index.md
    - 工具接口规范: tools/interfaces.md
    - DNS 工具: tools/dns/index.md
    - Explore 数据探索: tools/explore/index.md
    - FRP 内网穿透: tools/frp.md
    - Nginx 配置生成: tools/nginx/index.md
    - Serve 本地服务: tools/serve/index.md
    - SVG 转 GIF: tools/svg2gif.md
    - TP-Link 路由器: tools/tplogin.md
    - CC-Connect 管理: tools/cc/index.md
    - CRS 查询工具: tools/crs/index.md
    - MCP 服务指南: mcp/index.md

  - 环境安装:
    - 概览: env/index.md
    - Chrome 环境: env/chrome.md
    - Codex 配置: env/codex.md
    - Lark CLI 配置: env/lark-cli.md
    - OpenCode 配置: env/opencode.md
    - Workspace 协作脚手架: env/workspace.md
    - FRP 安装: env/frp.md
    - Nginx 反向代理: env/nginx_proxy.md
    - Docker 模板: env/docker.md

  - 开发指南:
    - 开发指南: development-guide/index.md
    - 目录职责说明: development-guide/directory-responsibilities.md
    - 架构概览与设计特点: development-guide/architecture-overview.md
    - ChatStyle: development-guide/chatstyle.md
    - 任务驱动沉淀: development-guide/task-driven-iteration.md
    - Mock CLI Tests: development-guide/mock-cli-tests.md
    - CLI 规范化现状报告: development-guide/cli-normalization-report.md
    - CLI 开发规范设计: design/chattool-cli-interaction-design.md
    - 飞书能力设计: design/feishu-cli.md
    - 飞书任务编排工作流设计: design/feishu-task-orchestration-workflow.md
    - 创建 Python 包: development-guide/create-python-package.md
    - Python 库仓库构成设计: design/python-library-repo-structure.md

  - 博客:
    - Agent CLI 系列:
      - Codex CLI 教程: blog/agent-cli/codex-cli-guide.md
      - OpenCode CLI 教程: blog/agent-cli/opencode-cli-guide.md
      - Claude Code CLI 教程: blog/agent-cli/claude-cli-guide.md
      - Agent Loop 插件调研: blog/agent-cli/agent-loop-plugin-survey.md
      - Lark CLI 教程: blog/agent-cli/lark-cli-guide.md
      - cc-connect 教程: blog/agent-cli/cc-connect-guide.md
      - cc-connect 编排教程: blog/agent-cli/cc-connect-orchestration.md
      - Claude Relay Service 调研: blog/agent-cli/claude-relay-service-guide.md
      - ChatTool CRS 用法: blog/agent-cli/chattool-crs-guide.md
      - OAuth Token 刷新机制: blog/agent-cli/oauth-refresh-token-guide.md
    - 飞书消息与会话调试: blog/lark-message-session-debug.md
    - 白嫖 AI 生图实战: blog/free-image-guide.md
    - 从代码到 Agent 技能: blog/code_tool_skill.md
    - chatenv 配置发现机制: blog/chatenv-provider-discovery.md
    - v0.5.3 飞书机器人: blog/larkbot_v053.md
    - 飞书机器人教程: blog/larkbot-tutorial.md