doc(server): sync dist with master (#489) Align the server deploy, config template, Docker cluster, Gremlin Console and IDEA setup pages with hugegraph master. Drop the deprecated task.scheduler_type key, correct the compose file inventory and the env-var reference against docker-entrypoint.sh and the compose files, match the conf/ template snippets key by key, fix the container script mount path and the graphs endpoint, and document the startup script flags, the security-check Java range and the rocksdb-only build.
中文 | English
This is the source code repository for the HugeGraph documentation website.
For the HugeGraph database project, visit apache/hugegraph.
Only 3 steps are needed to run the documentation website locally.
Prerequisites: Go 1.27+ and Hugo Extended 0.165.0. OINK does not require Node.js, npm, PostCSS, or a vendored theme checkout.
# 1. Clone repository git clone https://github.com/apache/hugegraph-doc.git cd hugegraph-doc # 2. Verify the pinned theme module hugo mod graph # 3. Start the development server (auto-reload) hugo server
Open http://localhost:1313 to preview.
The module graph must resolve github.com/pgsty/oink@v1.0.0. For a production-equivalent check, run the strict build command shown below.
hugegraph-doc/ ├── content/ # 📄 Documentation content (Markdown) │ ├── cn/ # 🇨🇳 Chinese documentation │ │ ├── docs/ # Main documentation │ │ │ ├── quickstart/ # Quick start guides │ │ │ ├── config/ # Configuration docs │ │ │ ├── clients/ # Client docs │ │ │ ├── guides/ # User guides │ │ │ └── ... │ │ ├── blog/ # Blog posts │ │ └── community/ # Community pages │ └── en/ # 🇺🇸 English documentation (mirrors cn/ structure) │ ├── data/ # 🧭 Landing-page and footer data ├── i18n/cn.yaml # 🌐 OINK interface strings for the /cn/ locale ├── assets/ # 🖼️ Project brand assets ├── layouts/ # 📐 Hugo template overrides ├── static/ # 📁 Static files ├── go.mod / go.sum # 📌 Pinned OINK module └── hugo.yaml # ⚙️ Site configuration
master| Requirement | Description |
|---|---|
| Bilingual Updates | Update BOTH content/cn/ and content/en/ |
| PR Screenshots | Include before/after screenshots in PR |
| Markdown | Use Markdown with Hugo front matter |
See contribution.md for the pinned toolchain, strict build, OINK customization, and translation rules.
| Command | Description |
|---|---|
hugo server | Start dev server (hot reload) |
hugo --cleanDestinationDir --gc --minify --environment production --printPathWarnings --printI18nWarnings --panicOnWarning | Strict production build to ./public/ |
hugo server -p 8080 | Custom port |
这是 HugeGraph 官方文档网站 的源代码仓库。
如果你想查找 HugeGraph 数据库本身，请访问 apache/hugegraph。
只需 3 步即可在本地启动文档网站。
前置条件： Go 1.27+ 和 Hugo Extended 0.165.0。OINK 不需要 Node.js、npm、PostCSS 或检出到仓库内的主题副本。
# 1. 克隆仓库 git clone https://github.com/apache/hugegraph-doc.git cd hugegraph-doc # 2. 检查固定的主题模块 hugo mod graph # 3. 启动开发服务器（支持热重载） hugo server
打开 http://localhost:1313 预览网站。
模块图必须解析为 github.com/pgsty/oink@v1.0.0。需要执行与生产一致的检查时，请运行下方的严格构建命令。
hugegraph-doc/ ├── content/ # 📄 文档内容 (Markdown) │ ├── cn/ # 🇨🇳 中文文档 │ │ ├── docs/ # 主要文档目录 │ │ │ ├── quickstart/ # 快速开始指南 │ │ │ ├── config/ # 配置文档 │ │ │ ├── clients/ # 客户端文档 │ │ │ ├── guides/ # 使用指南 │ │ │ └── ... │ │ ├── blog/ # 博客文章 │ │ └── community/ # 社区页面 │ └── en/ # 🇺🇸 英文文档（与 cn/ 结构一致） │ ├── data/ # 🧭 首页与页尾数据 ├── i18n/cn.yaml # 🌐 /cn/ 语言的 OINK 界面文案 ├── assets/ # 🖼️ 项目品牌资源 ├── layouts/ # 📐 Hugo 模板覆盖 ├── static/ # 📁 静态文件 ├── go.mod / go.sum # 📌 固定的 OINK 模块 └── hugo.yaml # ⚙️ 站点配置
master 创建新分支| 要求 | 说明 |
|---|---|
| 双语更新 | 修改内容时需同时更新 content/cn/ 和 content/en/ |
| PR 截图 | 提交 PR 时需附上修改前后对比截图 |
| Markdown | 文档使用 Markdown 格式，带 Hugo front matter |
查看 contribution.md 了解固定工具链、严格构建、OINK 定制和翻译要求。
| 命令 | 说明 |
|---|---|
hugo server | 启动开发服务器（热重载） |
hugo --cleanDestinationDir --gc --minify --environment production --printPathWarnings --printI18nWarnings --panicOnWarning | 严格构建生产版本到 ./public/ |
hugo server -p 8080 | 指定端口 |
Thanks to all contributors to the HugeGraph documentation!