mkdocs.yml

site_name: Nebula Graph Database 手册
site_description: Documentation for Nebula Graph Database
site_author: Nebula Graph
site_url: https://docs.nebula-graph.com.cn/
edit_uri: 'edit/v3.0.0/docs-2.0/'
docs_dir: docs-2.0

# repository
repo_name: 'vesoft-inc/nebula-docs-cn'
repo_url: 'https://github.com/vesoft-inc/nebula-docs-cn'

# Copyright
copyright: Copyright © 2022 Nebula Graph - 浙ICP备20010487号

# Configuration
theme:
  name: 'material'
  custom_dir: overrides
  logo: 'https://cloud-cdn.nebula-graph.com.cn/vesoft-nebula-logo-white.png'
  favicon: 'assets/images/favicon.ico'
  # Change color in `stylesheets > extra.css`
  palette:
    - scheme: nebula
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.top
    - header.autohide
  language: 'zh'

extra_css:
  - 'stylesheets/logo.css'
  - stylesheets/note.css
  - css/version-select.css
  - stylesheets/extra.css
extra:
  nebula:
    release: 3.0.0
    nightly: nightly
    master: master
    base20: 2.0
    base200: 2.0.0
    branch: 3.0.0
  version:
    method: mike
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/vesoft-inc/nebula-docs-cn'
  studio:
    base111b: 1.1.1-beta
    base220: 2.2.1
    base300: 3.0.0
    release: 3.2.0
  explorer:
    base100: 1.0.0
    release: 2.1.0
  exchange_ent:
    release: 2.6.1
    branch: v2.6.1
  exchange:
    release: 2.6.1
    branch: v2.6
    tag: v2.6.1
  importer:
    release: 2.6.0
    branch: v2.6.0
  algorithm:
    release: 2.6.2
    branch: v2.6
  plato:
    release: 1.0.0
    branch: v1.0.0
  sparkconnector:
    release: 2.6.1
    branch: v2.6
    tag: v2.6.1
  flinkconnector:
    release: 2.6.1
    branch: v2.6
    tag: v2.6.1
  dockercompose:
    release: 2.6.0
    branch: v2.6.0
  common:
    release: 2.5.0
  dashboard:
    release: 1.0.2
    base100: 1.0.0
    branch: v1.0.2
  dashboard_ent:
    release: 1.0.0
  console:
    release: 2.6.0
    branch: v2.6.0
  br:
    release: 0.5.0
  cpp:
    release: 2.5.0
    branch: v2.5.0
  java:
    release: 2.6.1
    branch: v2.6.1
  python:
    release: 2.6.0
    branch: v2.6.0
  go:
    release: 2.6.0
    branch: v2.6.0
  bench:
    release: 1.0.0
    branch: master
    tag: v1.0.0
  operator:
    release: 0.9.0
    branch: v0.9.0

nav:
  - 前言: README.md
  - 简介:
      - 什么是 Nebula Graph: 1.introduction/1.what-is-nebula-graph.md
      - 数据模型: 1.introduction/2.data-model.md
      - 路径: 1.introduction/2.1.path.md
      - VID: 1.introduction/3.vid.md
      - 服务架构:
        - 架构总览: 1.introduction/3.nebula-graph-architecture/1.architecture-overview.md
        - Meta 服务: 1.introduction/3.nebula-graph-architecture/2.meta-service.md
        - Graph 服务: 1.introduction/3.nebula-graph-architecture/3.graph-service.md
        - Storage 服务: 1.introduction/3.nebula-graph-architecture/4.storage-service.md

  - 快速入门:
      - 快速入门流程: 2.quick-start/1.quick-start-workflow.md
      - 步骤1：安装 Nebula Graph: 2.quick-start/2.install-nebula-graph.md
      - 步骤2：启动 Nebula Graph: 2.quick-start/5.start-stop-service.md
      - 步骤3：连接 Nebula Graph: 2.quick-start/3.connect-to-nebula-graph.md
      - 步骤4：使用常用命令: 2.quick-start/4.nebula-graph-crud.md
      - nGQL 命令汇总: 2.quick-start/6.cheatsheet-for-ngql-command.md

  - nGQL 指南:
      - nGQL 概述:
        - 什么是 nGQL: 3.ngql-guide/1.nGQL-overview/1.overview.md
        - 图模式: 3.ngql-guide/1.nGQL-overview/3.graph-patterns.md
        - 注释: 3.ngql-guide/1.nGQL-overview/comments.md
        - 大小写区分: 3.ngql-guide/1.nGQL-overview/identifier-case-sensitivity.md
        - 关键字: 3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
        - nGQL 风格指南: 3.ngql-guide/1.nGQL-overview/ngql-style-guide.md

      - 数据类型:
        - 数值: 3.ngql-guide/3.data-types/1.numeric.md
        - 布尔: 3.ngql-guide/3.data-types/2.boolean.md
        - 字符串: 3.ngql-guide/3.data-types/3.string.md
        - 日期时间: 3.ngql-guide/3.data-types/4.date-and-time.md
        - NULL: 3.ngql-guide/3.data-types/5.null.md
        - 列表: 3.ngql-guide/3.data-types/6.list.md
        - 集合: 3.ngql-guide/3.data-types/7.set.md
        - 映射: 3.ngql-guide/3.data-types/8.map.md
        - 类型转换: 3.ngql-guide/3.data-types/9.type-conversion.md
        - 地理位置: 3.ngql-guide/3.data-types/10.geography.md

      - 变量和复合查询:
        - 复合查询: 3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md
        - 自定义变量: 3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md
        - 引用属性: 3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md

      - 运算符:
          - 比较符: 3.ngql-guide/5.operators/1.comparison.md
          - 布尔符: 3.ngql-guide/5.operators/2.boolean.md
          - 管道符: 3.ngql-guide/5.operators/4.pipe.md
          - 属性引用符: 3.ngql-guide/5.operators/5.property-reference.md
          - 集合运算符: 3.ngql-guide/5.operators/6.set.md
          - 字符串运算符: 3.ngql-guide/5.operators/7.string.md
          - 列表运算符: 3.ngql-guide/5.operators/8.list.md
          - 运算符优先级: 3.ngql-guide/5.operators/9.precedence.md

      - 函数和表达式:
          - 数学函数: 3.ngql-guide/6.functions-and-expressions/1.math.md
          - 字符串函数: 3.ngql-guide/6.functions-and-expressions/2.string.md
          - 日期时间函数: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md
          - Schema 函数: 3.ngql-guide/6.functions-and-expressions/4.schema.md
          - CASE 表达式: 3.ngql-guide/6.functions-and-expressions/5.case-expressions.md
          - 列表函数: 3.ngql-guide/6.functions-and-expressions/6.list.md
          - count 函数: 3.ngql-guide/6.functions-and-expressions/7.count.md
          - collect 函数: 3.ngql-guide/6.functions-and-expressions/10.collect.md
          - reduce 函数: 3.ngql-guide/6.functions-and-expressions/11.reduce.md
          - hash 函数: 3.ngql-guide/6.functions-and-expressions/12.hash.md
          - concat 函数: 3.ngql-guide/6.functions-and-expressions/13.concat.md
          - 谓词函数: 3.ngql-guide/6.functions-and-expressions/8.predicate.md
          - geo 函数: 3.ngql-guide/6.functions-and-expressions/14.geo.md
          - 自定义函数: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md

      - 通用查询语句:
          - MATCH: 3.ngql-guide/7.general-query-statements/2.match.md
          - OPTIONAL MATCH: 3.ngql-guide/7.general-query-statements/optional-match.md
          - LOOKUP: 3.ngql-guide/7.general-query-statements/5.lookup.md
          - GO: 3.ngql-guide/7.general-query-statements/3.go.md
          - FETCH: 3.ngql-guide/7.general-query-statements/4.fetch.md
          - SHOW:
            - SHOW CHARSET: 3.ngql-guide/7.general-query-statements/6.show/1.show-charset.md
            - SHOW COLLATION: 3.ngql-guide/7.general-query-statements/6.show/2.show-collation.md
            - SHOW CREATE SPACE: 3.ngql-guide/7.general-query-statements/6.show/4.show-create-space.md
            - SHOW CREATE TAG/EDGE: 3.ngql-guide/7.general-query-statements/6.show/5.show-create-tag-edge.md
            - SHOW HOSTS: 3.ngql-guide/7.general-query-statements/6.show/6.show-hosts.md
            - SHOW INDEX STATUS: 3.ngql-guide/7.general-query-statements/6.show/7.show-index-status.md
            - SHOW INDEXES: 3.ngql-guide/7.general-query-statements/6.show/8.show-indexes.md
            - SHOW PARTS: 3.ngql-guide/7.general-query-statements/6.show/9.show-parts.md
            - SHOW ROLES: 3.ngql-guide/7.general-query-statements/6.show/10.show-roles.md
            - SHOW SNAPSHOTS: 3.ngql-guide/7.general-query-statements/6.show/11.show-snapshots.md
            - SHOW SPACES: 3.ngql-guide/7.general-query-statements/6.show/12.show-spaces.md
            - SHOW STATS: 3.ngql-guide/7.general-query-statements/6.show/14.show-stats.md
            - SHOW TAGS/EDGES: 3.ngql-guide/7.general-query-statements/6.show/15.show-tags-edges.md
            - SHOW USERS: 3.ngql-guide/7.general-query-statements/6.show/16.show-users.md
            - SHOW SESSIONS: 3.ngql-guide/7.general-query-statements/6.show/17.show-sessions.md
            - SHOW QUERIES: 3.ngql-guide/7.general-query-statements/6.show/18.show-queries.md
            - SHOW META LEADER: 3.ngql-guide/7.general-query-statements/6.show/19.show-meta-leader.md

      - 子句和选项:
          - GROUP BY: 3.ngql-guide/8.clauses-and-options/group-by.md
          - LIMIT and SKIP: 3.ngql-guide/8.clauses-and-options/limit.md
          - SAMPLE: 3.ngql-guide/8.clauses-and-options/sample.md
          - ORDER BY: 3.ngql-guide/8.clauses-and-options/order-by.md
          - RETURN: 3.ngql-guide/8.clauses-and-options/return.md
          - TTL: 3.ngql-guide/8.clauses-and-options/ttl-options.md
          - WHERE: 3.ngql-guide/8.clauses-and-options/where.md
          - YIELD: 3.ngql-guide/8.clauses-and-options/yield.md
          - WITH: 3.ngql-guide/8.clauses-and-options/with.md
          - UNWIND: 3.ngql-guide/8.clauses-and-options/unwind.md

      - 图空间语句:
          - CREATE SPACE: 3.ngql-guide/9.space-statements/1.create-space.md
          - USE SPACE: 3.ngql-guide/9.space-statements/2.use-space.md
          - SHOW SPACES: 3.ngql-guide/9.space-statements/3.show-spaces.md
          - DESCRIBE SPACE: 3.ngql-guide/9.space-statements/4.describe-space.md
          - DROP SPACE: 3.ngql-guide/9.space-statements/5.drop-space.md

      - Tag 语句:
          - CREATE TAG: 3.ngql-guide/10.tag-statements/1.create-tag.md
          - DROP TAG: 3.ngql-guide/10.tag-statements/2.drop-tag.md
          - ALTER TAG: 3.ngql-guide/10.tag-statements/3.alter-tag.md
          - SHOW TAGS: 3.ngql-guide/10.tag-statements/4.show-tags.md
          - DESCRIBE TAG: 3.ngql-guide/10.tag-statements/5.describe-tag.md
          - DELETE TAG: 3.ngql-guide/10.tag-statements/6.delete-tag.md
          - 增加和删除标签: 3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md
      - Edge type 语句:
          - CREATE EDGE: 3.ngql-guide/11.edge-type-statements/1.create-edge.md
          - DROP EDGE: 3.ngql-guide/11.edge-type-statements/2.drop-edge.md
          - ALTER EDGE: 3.ngql-guide/11.edge-type-statements/3.alter-edge.md
          - SHOW EDGES: 3.ngql-guide/11.edge-type-statements/4.show-edges.md
          - DESCRIBE EDGE: 3.ngql-guide/11.edge-type-statements/5.describe-edge.md

      - 点语句:
          - INSERT VERTEX: 3.ngql-guide/12.vertex-statements/1.insert-vertex.md
          - DELETE VERTEX: 3.ngql-guide/12.vertex-statements/4.delete-vertex.md
          - UPDATE VERTEX: 3.ngql-guide/12.vertex-statements/2.update-vertex.md
          - UPSERT VERTEX: 3.ngql-guide/12.vertex-statements/3.upsert-vertex.md

      - 边语句:
        - INSERT EDGE: 3.ngql-guide/13.edge-statements/1.insert-edge.md
        - DELETE EDGE: 3.ngql-guide/13.edge-statements/4.delete-edge.md
        - UPDATE EDGE: 3.ngql-guide/13.edge-statements/2.update-edge.md
        - UPSERT EDGE: 3.ngql-guide/13.edge-statements/3.upsert-edge.md

      - 原生索引:
        - 索引介绍: 3.ngql-guide/14.native-index-statements/README.md
        - CREATE INDEX: 3.ngql-guide/14.native-index-statements/1.create-native-index.md
        - SHOW INDEX: 3.ngql-guide/14.native-index-statements/2.show-native-indexes.md
        - SHOW CREATE INDEX: 3.ngql-guide/14.native-index-statements/2.1.show-create-index.md
        - DESCRIBE INDEX: 3.ngql-guide/14.native-index-statements/3.describe-native-index.md
        - REBUILD INDEX: 3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md
        - SHOW INDEX STATUS: 3.ngql-guide/14.native-index-statements/5.show-native-index-status.md
        - DROP INDEX: 3.ngql-guide/14.native-index-statements/6.drop-native-index.md

      - 全文索引:
#        - 索引介绍: 3.ngql-guide/14.native-index-statements/README.md
        - 全文索引限制: 4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md
        - 部署全文索引: 4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md
        - 部署 Raft listener: 4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md
        - 全文搜索: 3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md

      - 子图和路径:
          - GET SUBGRAPH: 3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md
          - FIND PATH: 3.ngql-guide/16.subgraph-and-path/2.find-path.md

      - 查询调优:
          - EXPLAIN和PROFILE: 3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md

      - 运维:
        # - CONFIG syntax: 3.ngql-guide/18.operation-and-maintenance-statements/1.configs-syntax.md
        - BALANCE: 3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md
        - 作业管理: 3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md
        - 终止查询: 3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md

  - 安装部署:
      - 准备资源: 4.deployment-and-installation/1.resource-preparations.md
      - 编译与安装:
          - 使用源码安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
          - 使用 RPM/DEB 包安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
          - 使用 tar.gz 文件安装: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
          - 使用 Docker Compose 部署: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
          - 使用 RPM/DEB 包部署多机集群: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
      - 安装存算合并版 Nebula Graph: 4.deployment-and-installation/standalone-deployment.md
      - 设置企业版 License: 4.deployment-and-installation/deploy-license.md      
      - 管理服务: 4.deployment-and-installation/manage-service.md
      - 连接服务: 4.deployment-and-installation/connect-to-nebula-graph.md
      - 管理逻辑机架（Zone）: 4.deployment-and-installation/5.zone.md
      - 升级版本:
          - 升级历史版本至当前版本: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
          - 升级 v2.0.x 至当前版本: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md
      - 卸载 Nebula Graph: 4.deployment-and-installation/4.uninstall-nebula-graph.md

  - 配置与日志:
      - 配置:
          - 配置管理: 5.configurations-and-logs/1.configurations/1.configurations.md
          - Meta 服务配置: 5.configurations-and-logs/1.configurations/2.meta-config.md
          - Graph 服务配置: 5.configurations-and-logs/1.configurations/3.graph-config.md
          - Storage 服务配置: 5.configurations-and-logs/1.configurations/4.storage-config.md
          - Linux 内核配置: 5.configurations-and-logs/1.configurations/6.kernel-config.md
      - 日志:
          - 日志配置: 5.configurations-and-logs/2.log-management/logs.md

  - 监控:
      - 查询 Nebula Graph 监控指标: 6.monitor-and-metrics/1.query-performance-metrics.md
      - RocksDB 统计数据: 6.monitor-and-metrics/2.rocksdb-statistics.md

  - 数据安全:
      - 验证和授权:
          - 身份验证: 7.data-security/1.authentication/1.authentication.md
          - 用户管理: 7.data-security/1.authentication/2.management-user.md
          - 内置角色权限: 7.data-security/1.authentication/3.role-list.md
          - OpenLDAP 验证: 7.data-security/1.authentication/4.ldap.md
#      - 备份恢复:
#          - 什么是 BR: 7.data-security/2.backup-restore/1.what-is-br.md
#          - 编译 BR: 7.data-security/2.backup-restore/2.compile-br.md
#          - 使用 BR 备份数据: 7.data-security/2.backup-restore/3.br-backup-data.md
#          - 使用 BR 恢复数据: 7.data-security/2.backup-restore/4.br-restore-data.md
      - 管理快照: 7.data-security/3.manage-snapshot.md
      - SSL 加密: 7.data-security/4.ssl.md

  - 最佳实践:
      - Compaction: 8.service-tuning/compaction.md
      - Storage 负载均衡: 8.service-tuning/load-balance.md
      - 图建模: 8.service-tuning/2.graph-modeling.md
      - 系统建模: 8.service-tuning/3.system-design.md
      - 执行计划: 8.service-tuning/4.plan.md
      - 超级节点(稠密点): 8.service-tuning/super-node.md
      - 实践案例: 8.service-tuning/practice.md


  - 客户端:
    - 客户端介绍: 14.client/1.nebula-client.md
    - Nebula Console: nebula-console.md
    - Nebula CPP: 14.client/3.nebula-cpp-client.md
    - Nebula Java: 14.client/4.nebula-java-client.md
    - Nebula Python: 14.client/5.nebula-python-client.md
    - Nebula Go: 14.client/6.nebula-go-client.md

  - Nebula Graph Cloud:
    - 什么是 Nebula Graph Cloud: nebula-cloud/1.what-is-cloud.md
    - 创建订阅: nebula-cloud/2.how-to-create-subsciption.md
    - 配置Solution: nebula-cloud/3.how-to-set-solution.md
    - Cloud Solution 角色身份说明: nebula-cloud/4.user-role-description.md
    - Solution 操作:
      - Solution: nebula-cloud/5.solution/5.0.introduce-solution.md
      - 配套的应用（Dashboard/Studio/Explorer）: nebula-cloud/5.solution/5.1.supporting-application.md
      - Private Link: nebula-cloud/5.solution/5.2.connection-configuration-and-use.md
      - 管理角色权限: nebula-cloud/5.solution/5.3.role-and-authority-management.md
    - 价格: nebula-cloud/6.pricing.md
    - 用户服务条款: nebula-cloud/7.terms-and-conditions.md
    - 隐私政策条款: nebula-cloud/8.privacy-policy.md

  - Nebula Graph Studio:
    - Studio 版本更新说明: nebula-studio/about-studio/st-ug-release-note.md
    - 认识 Nebula Graph Studio:
      - 什么是 Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
      - 名词解释: nebula-studio/about-studio/st-ug-terms.md
      - 使用限制: nebula-studio/about-studio/st-ug-limitations.md
      - 版本更新: nebula-studio/about-studio/st-ug-check-updates.md
      - 快捷键: nebula-studio/about-studio/st-ug-shortcuts.md
    - 安装与登录:
      - 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy.md
      - 使用 Helm 部署 Studio: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
      - 连接数据库: nebula-studio/deploy-connect/st-ug-connect.md
      - 清除连接: nebula-studio/deploy-connect/st-ug-reset-connection.md
    - 快速开始:
      - 规划 Schema: nebula-studio/quick-start/st-ug-plan-schema.md
      - 创建 Schema: nebula-studio/quick-start/st-ug-create-schema.md
      - 导入数据: nebula-studio/quick-start/st-ug-import-data.md
      - 查询图数据: nebula-studio/quick-start/st-ug-explore.md
    - 操作指南:
      - 管理 Schema:
        - 操作图空间: nebula-studio/manage-schema/st-ug-crud-space.md
        - 操作 Tag: nebula-studio/manage-schema/st-ug-crud-tag.md
        - 操作 Edge type: nebula-studio/manage-schema/st-ug-crud-edge-type.md
        - 操作索引: nebula-studio/manage-schema/st-ug-crud-index.md
      - 使用控制台:
        - 控制台界面: nebula-studio/use-console/st-ug-console.md
        - 导入图探索: nebula-studio/use-console/st-ug-open-in-explore.md
        - 查看子图: nebula-studio/use-console/st-ug-visualize-subgraph.md
    - 故障排查:
      - 连接数据库错误: nebula-studio/troubleshooting/st-ug-config-server-errors.md
      - 无法访问 Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
      - Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md

  - Nebula Dashboard（社区版）:
      - 什么是Nebula Dashboard: nebula-dashboard/1.what-is-dashboard.md
      - 部署 Dashboard: nebula-dashboard/2.deploy-dashboard.md
      - 连接 Dashboard: nebula-dashboard/3.connect-dashboard.md
      - Dashboard 页面介绍: nebula-dashboard/4.use-dashboard.md
      - 监控指标说明: nebula-dashboard/6.monitor-parameter.md

  - Nebula Dashboard（企业版）:
      - 什么是 Nebula Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md
      - 部署 Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
      - 创建及导入集群:
        - 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md
        - 导入集群: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md
      - 集群管理:
        - 集群总览: nebula-dashboard-ent/4.cluster-operator/1.overview.md
        - 集群监控: nebula-dashboard-ent/4.cluster-operator/2.monitor.md
        - 监控告警: nebula-dashboard-ent/9.alerts.md
        - 集群信息: nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md
        - 集群操作: nebula-dashboard-ent/4.cluster-operator/4.manage.md
        - 操作记录: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md
        - 其他设置: nebula-dashboard-ent/4.cluster-operator/6.settings.md
      - 权限管理: nebula-dashboard-ent/5.account-management.md
      - 全局配置: nebula-dashboard-ent/6.global-config.md
      - 任务中心: nebula-dashboard-ent/10.tasks.md
      - 监控指标说明: nebula-dashboard-ent/7.monitor-parameter.md
      - 常见问题 FAQ: nebula-dashboard-ent/8.faq.md

  - Nebula Explorer:
      - 什么是 Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
      - 安装与登录:
        - 部署 Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
        - 连接数据库: nebula-explorer/deploy-connect/ex-ug-connect.md
      - 操作指南:
        - 页面概览: nebula-explorer/operation-guide/ex-ug-page-overview.md
        - 查询探索: nebula-explorer/operation-guide/ex-ug-query-exploration.md
        - 图探索拓展: nebula-explorer/operation-guide/ex-ug-graph-exploration.md
        - 画布操作: nebula-explorer/operation-guide/ex-ug-canvas.md
        - 关系列表: nebula-explorer/operation-guide/ex-ug-relationship-list.md
        - 快捷键: nebula-explorer/operation-guide/ex-ug-shortcuts.md

  - Nebula Importer:
    - 使用 Nebula Importer: nebula-importer/use-importer.md
    - 有表头配置说明: nebula-importer/config-with-header.md
    - 无表头配置说明: nebula-importer/config-without-header.md

  - Nebula Exchange:
    - 认识 Nebula Exchange:
      - 什么是 Nebula Exchange: nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
      - 使用限制: nebula-exchange/about-exchange/ex-ug-limitations.md
    - 获取 Nebula Exchange: nebula-exchange/ex-ug-compile.md
    - 参数说明:
      - 导入命令参数: nebula-exchange/parameter-reference/ex-ug-para-import-command.md
      - 配置参数: nebula-exchange/parameter-reference/ex-ug-parameter.md
    - 使用 Nebula Exchange:
      - 导入 CSV 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-csv.md
      - 导入 JSON 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-json.md
      - 导入 ORC 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-orc.md
      - 导入 Parquet 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
      - 导入 HBase 数据: nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
      - 导入 MySQL 数据: nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
      - 导入 ClickHouse 数据: nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
      - 导入 Neo4j 数据: nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
      - 导入 Hive 数据: nebula-exchange/use-exchange/ex-ug-import-from-hive.md
      - 导入 MaxCompute 数据: nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
      - 导入 Pulsar 数据: nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
      - 导入 Kafka 数据: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
      - 导入 SST 文件数据: nebula-exchange/use-exchange/ex-ug-import-from-sst.md
      - 导出 Nebula Graph 数据: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md
    - Exchange 常见问题: nebula-exchange/ex-ug-FAQ.md

  - Nebula Operator:
      - 什么是 Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md
      - 使用流程: nebula-operator/6.get-started-with-operator.md
      - 部署 Nebula Operator: nebula-operator/2.deploy-nebula-operator.md
      - 部署 Nebula Graph集群: 
        - 使用 Kubectl 部署 Nebula Graph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
        - 使用 Helm 部署 Nebula Graph 集群: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
      - 配置 Nebula Graph 集群:
        - 自定义 Nebula Graph 集群的配置参数: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md
        - 回收 PV: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md 
        - 均衡扩容后的 Storage 数据: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
      - 升级 Nebula Graph 集群: nebula-operator/9.upgrade-nebula-cluster.md   
      - 连接 Nebula Graph 数据库: nebula-operator/4.connect-to-nebula-graph-service.md
      - 故障自愈: nebula-operator/5.operator-failover.md
      - 常见问题: nebula-operator/7.operator-faq.md

  - Nebula Algorithm: nebula-algorithm.md

  - Nebula Plato: nebula-plato.md

  - Nebula Spark Connector: nebula-spark-connector.md
      
  - Nebula Flink Connector: nebula-flink-connector.md

  - Nebula Bench: nebula-bench.md

  - 附录:
      - Release Note: 20.appendix/releasenote.md
      - 学习路径: 20.appendix/learning-path.md
      - 常见问题 FAQ: 20.appendix/0.FAQ.md
      - 生态工具概览: 20.appendix/6.eco-tool-version.md
      - 导入工具选择: 20.appendix/write-tools.md
      - 社区参与: 15.contribution/how-to-contribute.md
      - 思维导图: 20.appendix/mind-map.md

  - English Docs: https://docs.nebula-graph.io/
  - PDF: ./pdf/NebulaGraph-CN.pdf

# Extensions
markdown_extensions:
  - footnotes
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
#      toc_depth: 3
      permalink: true
      separator: "_"
  - mdx_truly_sane_lists
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: docs-2.0/reuse/
  - pymdownx.arithmatex:
      generic: true

# Plugins
plugins:
  - search
  - macros:
      include_dir: docs-2.0/reuse/
  - git-revision-date-localized

  - exclude:
# Exclude files with unix-style wildcards (globs)
      glob:
# Exclude all files in a directory. The path starts with the directory name in docs-2.0, such as `20.appendix/*`.
        - 7.data-security/2.backup-restore/*
        - nebula-flink/*
        - CHANGELOG.md
        - spark-connector/*
# Exclude the file with the following file name.
#        - abc.md
# Exclude files with regular expressions (regexes)
#    regex:
#      - '.*\.(tmp|bin|tar)$'

  - with-pdf:
      copyright: 2022 vesoft Inc.
      cover_subtitle: v3.0.0
      author: 吴敏，周瑶，梁振亚，杨怡璇，黄凤仙
      cover: true
      back_cover: true
      cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png'
      output_path: pdf/NebulaGraph-CN.pdf

extra_javascript:
  - js/version-select.js
  - js/config.js
  - js/jquery.js
  - js/init.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

google_analytics:
  - UA-60523578-15
  - auto