mkdocs.yml

# Project information
site_name: Nebula Graph Database Manual
site_description: Documentation for Nebula Graph Database
site_author: Nebula Graph
site_url: https://docs.nebula-graph.io/
edit_uri: 'edit/master/docs-2.0/'
docs_dir: docs-2.0

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

# Copyright
copyright: Copyright © 2021 Nebula Graph

# 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'
    palette:
      - scheme: default
        primary: teal
        accent: green
        toggle:
          icon: material/toggle-switch-off-outline
          name: Switch to dark mode
      - scheme: slate
        primary: deep orange
        accent: red
        toggle:
          icon: material/toggle-switch
          name: Switch to light mode
    features:
      - navigation.top
    language: 'en'

extra_css:
  - 'stylesheets/logo.css'
  - stylesheets/note.css
  - css/version-select.css
  - stylesheets/extra.css
extra:
  nebula:
    release: master
    nightly: nightly
    master: master
    base20: 2.0
    base200: 2.0.0
    branch: master
  version:
    method: mike
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/vesoft-inc/nebula-docs'
  studio:
    base111b: 1.1.1-beta
    base220: 2.2.1
    base300: 3.0.0
    release: 3.1.0
  explorer:
    base100: 1.0.0
    release: 2.1.0
  exchange_ent:
    release: 2.6.0
    branch: v2.6
  exchange:
    release: 2.6.1
    branch: v2.6
    tag: v2.6.1
  importer:
    release: 2.6.0
    branch: v2.6.0
  algorithm:
    release: 2.5.1
    branch: master
  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.1
  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:
  - About: README.md
  - Introduction:
      - What is Nebula Graph: 1.introduction/1.what-is-nebula-graph.md
      - Data model: 1.introduction/2.data-model.md
      - Path: 1.introduction/2.1.path.md
      - VID: 1.introduction/3.vid.md
      - Nebula Graph architecture:
        - Architecture overview: 1.introduction/3.nebula-graph-architecture/1.architecture-overview.md
        - Meta Service: 1.introduction/3.nebula-graph-architecture/2.meta-service.md
        - Graph Service: 1.introduction/3.nebula-graph-architecture/3.graph-service.md
        - Storage Service:  1.introduction/3.nebula-graph-architecture/4.storage-service.md

  - Quick start:
      - Quick start workflow: 2.quick-start/1.quick-start-workflow.md
      - Step 1 Install Nebula Graph: 2.quick-start/2.install-nebula-graph.md
      - Step 2 Manage Nebula Graph Service: 2.quick-start/5.start-stop-service.md
      - Step 3 Connect to Nebula Graph: 2.quick-start/3.connect-to-nebula-graph.md
      - Step 4 Use nGQL (CRUD): 2.quick-start/4.nebula-graph-crud.md
      - nGQL cheatsheet: 2.quick-start/6.cheatsheet-for-ngql.md

  - nGQL guide:
      - nGQL overview:
        - Overview: 3.ngql-guide/1.nGQL-overview/1.overview.md
        - Graph patterns: 3.ngql-guide/1.nGQL-overview/3.graph-patterns.md
        - Comments: 3.ngql-guide/1.nGQL-overview/comments.md
        - Identifier case sensitivity: 3.ngql-guide/1.nGQL-overview/identifier-case-sensitivity.md
        - Keywords: 3.ngql-guide/1.nGQL-overview/keywords-and-reserved-words.md
        - nGQL style guide: 3.ngql-guide/1.nGQL-overview/ngql-style-guide.md

      - Data types:
        - Numeric: 3.ngql-guide/3.data-types/1.numeric.md
        - Boolean: 3.ngql-guide/3.data-types/2.boolean.md
        - String: 3.ngql-guide/3.data-types/3.string.md
        - Date and time: 3.ngql-guide/3.data-types/4.date-and-time.md
        - Null: 3.ngql-guide/3.data-types/5.null.md
        - List: 3.ngql-guide/3.data-types/6.list.md
        - Set: 3.ngql-guide/3.data-types/7.set.md
        - Map: 3.ngql-guide/3.data-types/8.map.md
        - Type conversion: 3.ngql-guide/3.data-types/9.type-conversion.md
        - Geography: 3.ngql-guide/3.data-types/10.geography.md

      - Variables and composite queries:
        - Composite queries: 3.ngql-guide/4.variable-and-composite-queries/1.composite-queries.md
        - User-defined variables: 3.ngql-guide/4.variable-and-composite-queries/2.user-defined-variables.md
        - Property reference: 3.ngql-guide/4.variable-and-composite-queries/3.property-reference.md

      - Operators:
          - Comparison: 3.ngql-guide/5.operators/1.comparison.md
          - Boolean: 3.ngql-guide/5.operators/2.boolean.md
          - Pipe: 3.ngql-guide/5.operators/4.pipe.md
          - Property reference: 3.ngql-guide/5.operators/5.property-reference.md
          - Set: 3.ngql-guide/5.operators/6.set.md
          - String: 3.ngql-guide/5.operators/7.string.md
          - List: 3.ngql-guide/5.operators/8.list.md
          - Precedence: 3.ngql-guide/5.operators/9.precedence.md

      - Functions and expressions:
          - Math functions: 3.ngql-guide/6.functions-and-expressions/1.math.md
          - String functions: 3.ngql-guide/6.functions-and-expressions/2.string.md
          - Date and time functions: 3.ngql-guide/6.functions-and-expressions/3.date-and-time.md
          - Schema functions: 3.ngql-guide/6.functions-and-expressions/4.schema.md
          - Case expressions: 3.ngql-guide/6.functions-and-expressions/5.case-expressions.md
          - List functions: 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
          - Predicate functions: 3.ngql-guide/6.functions-and-expressions/8.predicate.md
          - Geography functions: 3.ngql-guide/6.functions-and-expressions/14.geo.md
          - User-defined functions: 3.ngql-guide/6.functions-and-expressions/9.user-defined-functions.md

      - General queries statements:
          - MATCH: 3.ngql-guide/7.general-query-statements/2.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
          - UNWIND: 3.ngql-guide/7.general-query-statements/7.unwind.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 CONFIGS: 3.ngql-guide/7.general-query-statements/6.show/3.show-configs.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

      - Clauses and options:
          - 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

      - Space statements:
          - 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 statements:
          - CREATE TAG: 3.ngql-guide/10.tag-statements/1.create-tag.md
          - DROP TAGS: 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
          - Add or delete tag: 3.ngql-guide/10.tag-statements/improve-query-by-tag-index.md

      - Edge type statements:
          - 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

      - Vertex statements:
          - 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

      - Edge statements:
        - 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

      - Native index statements:
        - Index overview: 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

      - Full-text index statements:
#        - Index overview: 3.ngql-guide/14.native-index-statements/README.md
        - Full-text restrictions: 4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md
        - Deploy Elasticsearch cluster: 4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md
        - Deploy Raft Listener cluster: 4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md
        - Search with full-text index: 3.ngql-guide/15.full-text-index-statements/1.search-with-text-based-index.md

      - Subgraph and path:
          - 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

      - Query tuning statements:
          - EXPLAIN and PROFILE: 3.ngql-guide/17.query-tuning-statements/1.explain-and-profile.md

      - Operation and maintenance statements:
        # - CONFIG syntax: 3.ngql-guide/18.operation-and-maintenance-statements/1.configs-syntax.md
        - BALANCE syntax: 3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md
        - Job statements: 3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md
        - Kill queries: 3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md

  - Deployment and installation:
      - Resource preparations: 4.deployment-and-installation/1.resource-preparations.md
      - Compile and install Nebula Graph:
          - Install Nebula Graph by compiling the source code: 4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md
          - Install Nebula Graph with RPM or DEB package: 4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md
          - Install Nebula Graph with the tar.gz file: 4.deployment-and-installation/2.compile-and-install-nebula-graph/4.install-nebula-graph-from-tar.md
          - Deploy Nebula Graph with Docker Compose: 4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
          - Deploy a Nebula Graph cluster on multiple servers: 4.deployment-and-installation/2.compile-and-install-nebula-graph/deploy-nebula-graph-cluster.md
      - Deploy license: 4.deployment-and-installation/deploy-license.md
      - Manage Service: 4.deployment-and-installation/manage-service.md
      - Connect to Service: 4.deployment-and-installation/connect-to-nebula-graph.md
      - Upgrade:
          - Upgrade Nebula Graph to the current version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md
          - Upgrade Nebula Graph from v2.0.x to the current version: 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md
      - Uninstall Nebula Graph: 4.deployment-and-installation/4.uninstall-nebula-graph.md

  - Configurations and logs:
      - Configurations:
          - Configurations: 5.configurations-and-logs/1.configurations/1.configurations.md
          - Meta Service configurations: 5.configurations-and-logs/1.configurations/2.meta-config.md
          - Graph Service configurations: 5.configurations-and-logs/1.configurations/3.graph-config.md
          - Storage Service configurations: 5.configurations-and-logs/1.configurations/4.storage-config.md
          - Kernel configurations: 5.configurations-and-logs/1.configurations/6.kernel-config.md
      - Log management:
          - Logs: 5.configurations-and-logs/2.log-management/logs.md

  - Monitor and metrics:
      - Query Nebula Graph metrics: 6.monitor-and-metrics/1.query-performance-metrics.md
      - RocksDB Statistics: 6.monitor-and-metrics/2.rocksdb-statistics.md

  - Data security:
      - Authentication and authorization:
          - Authentication: 7.data-security/1.authentication/1.authentication.md
          - User management: 7.data-security/1.authentication/2.management-user.md
          - Roles and privileges: 7.data-security/1.authentication/3.role-list.md
          - OpenLDAP authentication: 7.data-security/1.authentication/4.ldap.md
#      - Backup & Restore:
#          - What is Backup & Restore: 7.data-security/2.backup-restore/1.what-is-br.md
#          - Compile BR: 7.data-security/2.backup-restore/2.compile-br.md
#          - Use BR to back up data: 7.data-security/2.backup-restore/3.br-backup-data.md
#          - Use BR to restore data: 7.data-security/2.backup-restore/4.br-restore-data.md
      - Manage snapshots: 7.data-security/3.manage-snapshot.md
      - Group&Zone: 7.data-security/5.zone.md
      - SSL: 7.data-security/4.ssl.md

  - Practices:
    - Compaction: 8.service-tuning/compaction.md
    - Storage load balance: 8.service-tuning/load-balance.md
    - Modeling suggestions: 8.service-tuning/2.graph-modeling.md
    - System design suggestions: 8.service-tuning/3.system-design.md
    - Execution plan: 8.service-tuning/4.plan.md
    - Processing super vertices: 8.service-tuning/super-node.md
    - Best practices: 8.service-tuning/practice.md

  - Client:
    - Clients overview: 14.client/1.nebula-client.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 Studio:
    - Change Log: nebula-studio/about-studio/st-ug-release-note.md
    - About Nebula Graph Studio:
      - What is Nebula Graph Studio: nebula-studio/about-studio/st-ug-what-is-graph-studio.md
      - Explanations of terms: nebula-studio/about-studio/st-ug-terms.md
      - Limitations: nebula-studio/about-studio/st-ug-limitations.md
      - Check updates: nebula-studio/about-studio/st-ug-check-updates.md
      - Shortcuts: nebula-studio/about-studio/st-ug-shortcuts.md
    - Deploy and connect:
      - Deploy Studio: nebula-studio/deploy-connect/st-ug-deploy.md
      - Deploy Studio with Helm: nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
      - Connect to Nebula Graph: nebula-studio/deploy-connect/st-ug-connect.md
      - Clear connection: nebula-studio/deploy-connect/st-ug-reset-connection.md
    - Quick start:
      - Design a schema: nebula-studio/quick-start/st-ug-plan-schema.md
      - Create a schema: nebula-studio/quick-start/st-ug-create-schema.md
      - Import data: nebula-studio/quick-start/st-ug-import-data.md
      - Query graph data: nebula-studio/quick-start/st-ug-explore.md
    - Operation guide:
      - Use Schema:
        - Operate graph spaces: nebula-studio/manage-schema/st-ug-crud-space.md
        - Operate Tags: nebula-studio/manage-schema/st-ug-crud-tag.md
        - Operate Edge types: nebula-studio/manage-schema/st-ug-crud-edge-type.md
        - Operate Indexes: nebula-studio/manage-schema/st-ug-crud-index.md
      - Use Console:
        - Console: nebula-studio/use-console/st-ug-console.md
        - Open in Explore: nebula-studio/use-console/st-ug-open-in-explore.md
        - View subgraphs: nebula-studio/use-console/st-ug-visualize-subgraph.md
    - Troubleshooting:
      - Connecting to the database error: nebula-studio/troubleshooting/st-ug-config-server-errors.md
      - Cannot access to Studio: nebula-studio/troubleshooting/st-ug-connection-errors.md
      - FAQ: nebula-studio/troubleshooting/st-ug-faq.md

  - Nebula Dashboard Community Edition:
      - What is Nebula Dashboard: nebula-dashboard/1.what-is-dashboard.md
      - Deploy Dashboard: nebula-dashboard/2.deploy-dashboard.md
      - Connect Dashboard: nebula-dashboard/3.connect-dashboard.md
      - Use Dashboard: nebula-dashboard/4.use-dashboard.md
      - Monitor Parameter: nebula-dashboard/6.monitor-parameter.md

  - Nebula Dashboard Enterprise Edition:
      - What is Nebula Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md
      - Deploy Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
      - Create and Import Cluster:
        - Create clusters: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md
        - Import clusters: nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md
      - Cluster Operation:
        - Cluster Overview: nebula-dashboard-ent/4.cluster-operator/1.overview.md
        - Cluster Monitoring: nebula-dashboard-ent/4.cluster-operator/2.monitor.md
        - Cluster Information: nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md
        - Cluster Operation: nebula-dashboard-ent/4.cluster-operator/4.manage.md
        - Operation Record: nebula-dashboard-ent/4.cluster-operator/5.operation-record.md
        - Other Settings: nebula-dashboard-ent/4.cluster-operator/6.settings.md
      - Authority Management: nebula-dashboard-ent/5.account-management.md
      - System Settings: nebula-dashboard-ent/6.system-settings.md
      - Monitor Parameter: nebula-dashboard-ent/7.monitor-parameter.md
      - FAQ: nebula-dashboard-ent/8.faq.md

  - Nebula Explorer:
      - What is Nebula Explorer: nebula-explorer/about-explorer/ex-ug-what-is-explorer.md
      - Deploy and connect:
        - Deploy Explorer: nebula-explorer/deploy-connect/ex-ug-deploy.md
        - Connect to Nebula Graph: nebula-explorer/deploy-connect/ex-ug-connect.md
        - Reset connection: nebula-explorer/deploy-connect/ex-ug-reset-connection.md
      - Operation guide:
        - Page Overview: nebula-explorer/operation-guide/ex-ug-page-overview.md
        - Start query: nebula-explorer/operation-guide/ex-ug-query-exploration.md
        - Graph exploration and expansion: nebula-explorer/operation-guide/ex-ug-graph-exploration.md
        - Canvas operation: nebula-explorer/operation-guide/ex-ug-canvas.md
        - Relationship list: nebula-explorer/operation-guide/ex-ug-relationship-list.md
        - Shortcuts: nebula-explorer/operation-guide/ex-ug-shortcuts.md

  - Nebula Importer:
    - Use Nebula Importer: nebula-importer/use-importer.md
    - Configuration with Header: nebula-importer/config-with-header.md
    - Configuration without Header: nebula-importer/config-without-header.md

  - Nebula Exchange:
    - Introduction:
      - What is Nebula Exchange: nebula-exchange/about-exchange/ex-ug-what-is-exchange.md
      - Limitations: nebula-exchange/about-exchange/ex-ug-limitations.md
    - Get Exchange: nebula-exchange/ex-ug-compile.md
    - Exchange configurations:
      - Options for import: nebula-exchange/parameter-reference/ex-ug-para-import-command.md
      - Parameters in the configuration file: nebula-exchange/parameter-reference/ex-ug-parameter.md
    - Use Nebula Exchange:
      - Import data from CSV files: nebula-exchange/use-exchange/ex-ug-import-from-csv.md
      - Import data from JSON files: nebula-exchange/use-exchange/ex-ug-import-from-json.md
      - Import data from ORC files: nebula-exchange/use-exchange/ex-ug-import-from-orc.md
      - Import data from Parquet files: nebula-exchange/use-exchange/ex-ug-import-from-parquet.md
      - Import data from HBase: nebula-exchange/use-exchange/ex-ug-import-from-hbase.md
      - Import data from MySQL: nebula-exchange/use-exchange/ex-ug-import-from-mysql.md
      - Import data from ClickHouse: nebula-exchange/use-exchange/ex-ug-import-from-clickhouse.md
      - Import data from Neo4j: nebula-exchange/use-exchange/ex-ug-import-from-neo4j.md
      - Import data from Hive: nebula-exchange/use-exchange/ex-ug-import-from-hive.md
      - Import data from MaxCompute: nebula-exchange/use-exchange/ex-ug-import-from-maxcompute.md
      - Import data from Pulsar: nebula-exchange/use-exchange/ex-ug-import-from-pulsar.md
      - Import data from Kafka: nebula-exchange/use-exchange/ex-ug-import-from-kafka.md
      - Import data from SST files: nebula-exchange/use-exchange/ex-ug-import-from-sst.md
      - Export data from Nebula Graph: nebula-exchange/use-exchange/ex-ug-export-from-nebula.md
    - Exchange FAQ: nebula-exchange/ex-ug-FAQ.md

  - Nebula Operator:
      - What is Nebula Operator: nebula-operator/1.introduction-to-nebula-operator.md
      - Overview of using Nebula Operator: nebula-operator/6.get-started-with-operator.md
      - Deploy Nebula Operator: nebula-operator/2.deploy-nebula-operator.md
      - Deploy clusters: 
        - Deploy clusters with Kubectl: nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md
        - Deploy clusters with Helm: nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md
      - Configure clusters:
        - Custom configuration parameters for a Nebula Graph cluster: nebula-operator/8.custom-cluster-configurations/8.1.custom-conf-parameter.md
        - Reclaim PVs: nebula-operator/8.custom-cluster-configurations/8.2.pv-reclaim.md 
        - Balance storage data after scaling out: nebula-operator/8.custom-cluster-configurations/8.3.balance-data-when-scaling-storage.md
      - Upgrade Nebula Graph clusters: nebula-operator/9.upgrade-nebula-cluster.md
      - Connect to Nebula Graph databases: nebula-operator/4.connect-to-nebula-graph-service.md
      - Self-healing: nebula-operator/5.operator-failover.md
      - FAQ: nebula-operator/7.operator-faq.md

  - Nebula Algorithm: nebula-algorithm.md

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

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

  - Nebula Bench: nebula-bench.md

  - Appendix:
      - Learning path: 20.appendix/learning-path.md
      - Release Note: 20.appendix/releasenote.md
      - FAQ: 20.appendix/0.FAQ.md
      - Ecosystem tools: 20.appendix/6.eco-tool-version.md
      - Write tools: 20.appendix/write-tools.md
      - How to contribute: 15.contribution/how-to-contribute.md

  - 中文手册: https://docs.nebula-graph.com.cn/
  - PDF: ./pdf/NebulaGraph-EN.pdf


# Extensions
markdown_extensions:
  - footnotes
  - admonition
  - codehilite:
        guess_lang: false
  - toc:
        permalink: true
        separator: "_"
#        toc_depth: 1
  - 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: 2021 Vesoft Inc.
      cover_subtitle: master since v2.6.1
      author: Min Wu, Yao Zhou, Cooper Liang, Foesa Yang, Max Zhu, Abby Huang
      cover: true
      back_cover: true
      cover_logo: 'https://cloud-cdn.nebula-graph.com.cn/nebula-for-pdf.png'
      output_path: pdf/NebulaGraph-EN.pdf
      #show_anchors: true
      #render_js: true
      #headless_chrome_path: headless-chromium
      #enabled_if_env: ENABLE_PDF_EXPORT
      #debug_html: true
      #show_anchors: true
      #verbose: true

google_analytics:
  - UA-60523578-16
  - auto

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