mkdocs.yml

site_name: Cortex
site_url: https://fangxm233.github.io/cortex-agent/
site_description: Agent workbench for auto research, self-improvement loops, and long-running work
site_author: Cortex Team
repo_url: https://github.com/fangxm233/cortex-agent
repo_name: fangxm233/cortex-agent
edit_uri: edit/main/docs/

# docs/zh/README.md is the GitHub-rendered Chinese README (the root README.md links
# to ./docs/zh/, which GitHub resolves to that file). It is not a site page: the zh
# landing page is docs/zh/index.md, mirroring docs/index.md. Without this exclusion
# MkDocs maps both to the same URL and drops one with a build warning.
exclude_docs: |
  zh/README.md

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  # attr_list lets headings carry an explicit `{#slug}`. Required by docs/zh:
  # the toc slugifier strips CJK, so a Chinese-only heading would otherwise get
  # a positional `_N` id that silently shifts whenever a heading is added or
  # removed earlier on the page — and MkDocs logs the resulting dead anchors as
  # INFO, so even `--strict` does not catch the breakage. The docs-publish
  # workflow asserts no positional ids survive, so do not delete these slugs:
  # GitHub does not render attr_list and shows `{#slug}` literally when a
  # docs/zh source file is opened in the file tree — that is expected, and is
  # why docs/zh/README.md links to the published site rather than its siblings.
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

plugins:
  - search
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 首页
            Quickstart: 快速入门
            Desktop App: 桌面应用
            Browser Access: 浏览器访问
            Slack Setup: Slack 设置
            Configuration: 配置
            CLI Reference: CLI 参考
            Backends: 后端
            Architecture: 架构
            Team Mode: 团队模式
            Memory: 记忆
            Skills & Plugins: 技能与插件
            Scheduling: 调度
            Safety & Approvals: 安全与审批
            Telemetry: 遥测
            Hooks: 钩子
            Waitpoints: 等待点
            MCP: MCP
            Cross-machine: 跨机器
            Agent Browser: Agent 浏览器

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Desktop App: desktop-app.md
  - Browser Access: browser-access.md
  - Slack Setup: slack-setup.md
  - Configuration: configuration.md
  - CLI Reference: cli-reference.md
  - Backends: backends.md
  - Architecture: architecture.md
  - Team Mode: team.md
  - Memory: memory.md
  - Skills & Plugins: skills-and-plugins.md
  - Scheduling: scheduling.md
  - Safety & Approvals: safety-and-approvals.md
  - Telemetry: telemetry.md
  - Hooks: hooks.md
  - Waitpoints: waitpoints.md
  - MCP: mcp.md
  - Cross-machine: cross-machine.md
  - Agent Browser: agent-browser.md