| # Apache HugeGraph Documentation Website |
| |
| [](https://deepwiki.com/apache/hugegraph-doc) |
| [](LICENSE) |
| [](https://gohugo.io/) |
| |
| --- |
| |
| [中文](#中文版) | **English** |
| |
| This is the **source code repository** for the [HugeGraph documentation website](https://hugegraph.apache.org/docs/). |
| |
| For the HugeGraph database project, visit [apache/hugegraph](https://github.com/apache/hugegraph). |
| |
| ## Quick Start |
| |
| Only **3 steps** to run the documentation website locally: |
| |
| **Prerequisites:** [Hugo Extended](https://github.com/gohugoio/hugo/releases) v0.95+ and Node.js v16+ |
| |
| ```bash |
| # 1. Clone repository |
| git clone https://github.com/apache/hugegraph-doc.git |
| cd hugegraph-doc |
| |
| # 2. Install dependencies |
| npm install |
| |
| # 3. Start development server (auto-reload) |
| hugo server |
| ``` |
| |
| Open http://localhost:1313 to preview. |
| |
| > **Troubleshooting:** If you see `TOCSS: failed to transform "scss/main.scss"`, |
| > install Hugo **Extended** version, not the standard version. |
| |
| ## Repository Structure |
| |
| ``` |
| 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) |
| │ |
| ├── themes/docsy/ # 🎨 Docsy theme (git submodule) |
| ├── assets/ # 🖼️ Custom assets (fonts, images, scss) |
| ├── layouts/ # 📐 Hugo template overrides |
| ├── static/ # 📁 Static files |
| ├── config.toml # ⚙️ Site configuration |
| └── package.json # 📦 Node.js dependencies |
| ``` |
| |
| ## Contributing |
| |
| ### Contribution Workflow |
| |
| 1. **Fork** this repository |
| 2. Create a **new branch** from `master` |
| 3. Make your changes |
| 4. Submit a **Pull Request** with screenshots |
| |
| ### Requirements |
| |
| | 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 | |
| |
| ### Detailed Guide |
| |
| See [contribution.md](./contribution.md) for: |
| - Platform-specific Hugo installation |
| - Docsy theme customization |
| - Translation tips |
| |
| ## Commands |
| |
| | Command | Description | |
| |---------|-------------| |
| | `hugo server` | Start dev server (hot reload) | |
| | `hugo --minify` | Build production to `./public/` | |
| | `hugo server -p 8080` | Custom port | |
| |
| --- |
| |
| ## 中文版 |
| |
| 这是 [HugeGraph 官方文档网站](https://hugegraph.apache.org/docs/) 的**源代码仓库**。 |
| |
| 如果你想查找 HugeGraph 数据库本身，请访问 [apache/hugegraph](https://github.com/apache/hugegraph)。 |
| |
| ### 快速开始 |
| |
| 只需 **3 步**即可在本地启动文档网站： |
| |
| **前置条件：** [Hugo Extended](https://github.com/gohugoio/hugo/releases) v0.95+ 和 Node.js v16+ |
| |
| ```bash |
| # 1. 克隆仓库 |
| git clone https://github.com/apache/hugegraph-doc.git |
| cd hugegraph-doc |
| |
| # 2. 安装依赖 |
| npm install |
| |
| # 3. 启动开发服务器（支持热重载） |
| hugo server |
| ``` |
| |
| 打开 http://localhost:1313 预览网站。 |
| |
| > **常见问题：** 如果遇到 `TOCSS: failed to transform "scss/main.scss"` 错误， |
| > 说明你需要安装 Hugo **Extended** 版本，而不是标准版本。 |
| |
| ### 仓库结构 |
| |
| ``` |
| hugegraph-doc/ |
| ├── content/ # 📄 文档内容 (Markdown) |
| │ ├── cn/ # 🇨🇳 中文文档 |
| │ │ ├── docs/ # 主要文档目录 |
| │ │ │ ├── quickstart/ # 快速开始指南 |
| │ │ │ ├── config/ # 配置文档 |
| │ │ │ ├── clients/ # 客户端文档 |
| │ │ │ ├── guides/ # 使用指南 |
| │ │ │ └── ... |
| │ │ ├── blog/ # 博客文章 |
| │ │ └── community/ # 社区页面 |
| │ └── en/ # 🇺🇸 英文文档（与 cn/ 结构一致） |
| │ |
| ├── themes/docsy/ # 🎨 Docsy 主题 (git submodule) |
| ├── assets/ # 🖼️ 自定义资源 (fonts, images, scss) |
| ├── layouts/ # 📐 Hugo 模板覆盖 |
| ├── static/ # 📁 静态文件 |
| ├── config.toml # ⚙️ 站点配置 |
| └── package.json # 📦 Node.js 依赖 |
| ``` |
| |
| ### 如何贡献 |
| |
| #### 贡献流程 |
| |
| 1. **Fork** 本仓库 |
| 2. 基于 `master` 创建**新分支** |
| 3. 修改文档内容 |
| 4. 提交 **Pull Request**（附截图） |
| |
| #### 重要说明 |
| |
| | 要求 | 说明 | |
| |------|------| |
| | **双语更新** | 修改内容时需**同时更新** `content/cn/` 和 `content/en/` | |
| | **PR 截图** | 提交 PR 时需附上修改**前后对比截图** | |
| | **Markdown** | 文档使用 Markdown 格式，带 Hugo front matter | |
| |
| #### 详细指南 |
| |
| 查看 [contribution.md](./contribution.md) 了解： |
| - 各平台 Hugo 安装方法 |
| - Docsy 主题定制 |
| - 翻译技巧 |
| |
| ### 常用命令 |
| |
| | 命令 | 说明 | |
| |------|------| |
| | `hugo server` | 启动开发服务器（热重载） | |
| | `hugo --minify` | 构建生产版本到 `./public/` | |
| | `hugo server -p 8080` | 指定端口 | |
| |
| --- |
| |
| ## Contact & Community |
| |
| - **Issues:** [GitHub Issues](https://github.com/apache/hugegraph-doc/issues) |
| - **Mailing List:** [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscribe first](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/)) |
| - **Slack:** [ASF Slack](https://the-asf.slack.com/archives/C059UU2FJ23) |
| |
| <img src="./assets/images/wechat.png" alt="WeChat QR Code" width="350"/> |
| |
| ## Contributors |
| |
| Thanks to all contributors to the HugeGraph documentation! |
| |
| [](https://github.com/apache/hugegraph-doc/graphs/contributors) |
| |
| --- |
| |
| ## License |
| |
| [Apache License 2.0](LICENSE) |
