HugeGraph 项目文档编写指南

1. 项目的目录结构及介绍

HugeGraph 项目的文档仓库目录结构如下：

incubator-hugegraph-doc/
├── assets/
├── content/
│   ├── docs/
│   │   ├── api/
│   │   ├── config/
│   │   ├── guides/
│   │   ├── performance/
│   │   ├── query_language/
│   │   └── ...
│   └── ...
├── dist/
├── layouts/
├── static/
├── themes/
├── asf.yaml
├── editorconfig
├── gitignore
├── nvmrc
├── README.md
├── config.toml
├── contribution.md
├── deploy.sh
├── netlify.toml
└── package.json

目录结构介绍

• assets/: 存放项目资源文件。
• content/: 存放文档内容，包括各个模块的详细文档。
  • docs/: 主要文档目录，包含 API、配置、指南、性能、查询语言等子目录。
• dist/: 构建后的文档输出目录。
• layouts/: 文档布局模板。
• static/: 静态资源文件。
• themes/: 文档主题。
• asf.yaml, editorconfig, gitignore, nvmrc, README.md, config.toml, contribution.md, deploy.sh, netlify.toml, package.json: 项目配置和脚本文件。

2. 项目的启动文件介绍

HugeGraph 项目的启动文件主要是 deploy.sh，这是一个用于部署文档的脚本文件。通过运行该脚本，可以将文档构建并部署到指定的服务器上。

#!/bin/bash
# deploy.sh
# 该脚本用于部署 HugeGraph 文档

# 构建文档
hugo

# 部署到服务器
rsync -avz --delete public/ user@server:/path/to/docs

3. 项目的配置文件介绍

HugeGraph 项目的主要配置文件是 config.toml，这是一个用于配置文档站点的文件。以下是该文件的部分内容示例：

baseURL = "https://hugegraph.apache.org/"
languageCode = "en-us"
title = "HugeGraph Documentation"
theme = "docsy"

[params]
  description = "HugeGraph 文档"
  author = "Apache HugeGraph"

[menu]
  [[menu.main]]
    name = "文档"
    url = "/docs/"
    weight = 1
  [[menu.main]]
    name = "API"
    url = "/docs/api/"
    weight = 2
  [[menu.main]]
    name = "配置"
    url = "/docs/config/"
    weight = 3
  [[menu.main]]
    name = "指南"
    url = "/docs/guides/"
    weight = 4
  [[menu.main]]
    name = "性能"
    url = "/docs/performance/"
    weight = 5
  [[menu.main]]
    name = "查询语言"
    url = "/docs/query_language/"
    weight = 6

配置文件介绍

• baseURL: 文档站点的基本 URL。
• languageCode: 文档的语言代码。
• title: 文档站点的标题。
• theme: 文档使用的主题。
• params: 其他参数配置，如描述和作者。
• menu: 文档站点的菜单配置，包括各个模块的链接和权重。

通过以上配置，可以自定义文档站点的基本信息和导航菜单。