mkdocs.yml

site_name: "MeterSphere 文档"
site_url: "https://metersphere.io/docs"
site_description: "Document"
site_author: "飞致云"
google_analytics: ['UA-147297392-7', 'metersphere.io']

repo_name: "metersphere/metersphere"
repo_url: "https://github.com/metersphere/metersphere"

edit_uri: https://github.com/metersphere/docs/edit/master/docs/
theme:
    name: "material"
    logo: "img/logo-white.png"
    favicon: "img/facio.ico"
    language: "zh"
    highlightjs: true
    hljs_languages:
        - yaml
        - django
    palette:
        - scheme: default
          accent: deep purple
          toggle:
              icon: material/weather-night
              name: 切换为浅色模式
        - scheme: slate
          accent: deep purple
          toggle:
              icon: material/weather-sunny
              name: 切换为深色模式
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.indexes
        - navigation.top
        - search.suggest
        - search.highlight
        - search.share
        - header.autohide
    custom_dir: "theme"
nav:
    - 项目介绍: index.md
    - 系统架构: system_arch.md
    - 版本对比: https://metersphere.io/v3/pricing.html
    - 安装部署:
          - 网络端口要求: installation/network_port.md
          - 离线安装（生产环境推荐）: installation/offline_installation.md
          - 1Panel 安装: installation/1Panel.md
          - Task Runner 部署: installation/task_runner.md
          - 数据备份与还原: installation/backup_data.md
          - 命令行工具: installation/cli.md
    - 快速开始:
          - 使用用例管理: quick_start/test_case.md
          - 使用接口测试: quick_start/api_test.md
    - 功能手册:
          - 通用功能: user_manual/general.md
          - 工作台:
              - 首页: user_manual/workstation/index.md
              - 我的待办: user_manual/workstation/todo.md
              - 我关注的: user_manual/workstation/focus.md
              - 我创建的: user_manual/workstation/create.md
          - 项目管理:
              - 概述: user_manual/project_management/overview.md
              - 项目与权限: user_manual/project_management/project_permissions.md
              - 模板管理: user_manual/project_management/template_management.md
              - 文件管理: user_manual/project_management/file_management.md
              - 消息管理: user_manual/project_management/message_management.md
              - 公共脚本: user_manual/project_management/public_script.md
              - 环境管理: user_manual/project_management/environment.md
              - 日志: user_manual/project_management/log.md
          - 测试计划:
              - 概述: user_manual/test_plan/intro.md
              - 计划: user_manual/test_plan/test_plan.md
              - 报告: user_manual/test_plan/test_plan_report.md
          - 测试用例:
                - 概述: user_manual/test_case/intro.md
                - 用例: user_manual/test_case/test_case.md
                - 评审: user_manual/test_case/test_case_review.md
          - 接口测试:
                - 概述: user_manual/api_test/intro.md
                - 接口调试: user_manual/api_test/debug.md
                - 接口定义: user_manual/api_test/api_definition.md
                - 请求参数介绍: user_manual/api_test/request_params.md
                - 场景管理: user_manual/api_test/api_automation.md
                - 内置函数: user_manual/api_test/functions.md
                - 报告: user_manual/api_test/test_report.md
          - 缺陷管理:
              - 概述: user_manual/defect_management/overview.md
              - 缺陷管理: user_manual/defect_management/defect_management.md
          - 系统设置:
              - 概述: user_manual/system_management/intro.md
              - 系统: user_manual/system_management/system.md
              - 组织: user_manual/system_management/organization.md
          - 个人中心:
              - 个人信息: user_manual/personal_center/information.md
          - X-Pack:
              - 概述: user_manual/x-pack/intro.md
              - 组织: user_manual/x-pack/organization.md
              - 自定义主题: user_manual/x-pack/custom_theme.md
              - 单点认证:
                  - 企业微信: user_manual/x-pack/work_weixin.md
                  - 钉钉: user_manual/x-pack/dingding.md
                  - 飞书: user_manual/x-pack/feishu.md
                  - CAS: user_manual/x-pack/cas.md
                  - OIDC: user_manual/x-pack/oidc.md
                  - OAuth2.0: user_manual/x-pack/oauth2.md
                  - LDAP: user_manual/x-pack/ldap.md
              - 消息模板: user_manual/x-pack/message.md
              - 资源池: user_manual/x-pack/controller.md
    - 插件列表: plugin.md
    - 教学视频: video_index.md
    - 常见问题:
        - 安装部署: ask_question/install_question.md
        - 接口测试: ask_question/api_question.md
        - 如何接入AI: ask_question/ai_service.md
    - 开发文档:
          - 开发环境搭建: dev_manual/dev_manual.md
          - 接口自动化插件开发: dev_manual/api_plugin_dev.md
          - 第三方平台插件开发: dev_manual/platform_plugin_dev.md
    - 更新日志: about/changelog.md
    - 联系我们: about/contact.md

markdown_extensions:
    - admonition
    - codehilite:
          guess_lang: True
          linenums: False
    - toc:
          permalink: True
    - footnotes
    - attr_list
    - def_list
    - tables
    - abbr
    - md_in_html
    - pymdownx.extra
    - pymdownx.arithmatex
    - pymdownx.betterem:
          smart_enable: all
    - pymdownx.caret
    - pymdownx.critic
    - pymdownx.details
    - pymdownx.emoji:
          emoji_generator: !!python/name:pymdownx.emoji.to_png
    - pymdownx.inlinehilite
    - pymdownx.magiclink
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist
    - pymdownx.tilde
    - pymdownx.betterem
    - pymdownx.superfences
    - pymdownx.progressbar

extra_css:
    - css/extra.css

copyright: Copyright &copy; 2014-2026 <a href="https://www.fit2cloud.com">杭州飞致云信息科技有限公司</a>, All Rights Reserved. <a href="http://www.beian.miit.gov.cn" target="_blank">京ICP备15023818号</a>

plugins:
    - search:
        lang:
          - en
          - ja
        separator: '[\s\-\.]+'
    - glightbox

extra:
    version:
        provider: mike
    analytics:
        provider: google
        property: UA-147297392-7
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/metersphere
        - icon: fontawesome/solid/envelope
          link: mailto:support@fit2cloud.com
        - icon: fontawesome/solid/phone
          link: tel://400-052-0755