docs: describe HugeGraph as full-stack graph system (#456) * docs: describe HugeGraph as full-stack graph system Reword documentation to present HugeGraph as a full-stack graph system covering graph database (OLTP), graph computing (OLAP) and graph AI. Updated /docs/introduction/_index.md to expand the project summary and highlight GraphRAG/graph --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
中文 | English
This is the source code repository for the HugeGraph documentation website.
For the HugeGraph database project, visit apache/hugegraph.
Only 3 steps to run the documentation website locally:
Prerequisites: Hugo Extended v0.95+ and Node.js v16+
# 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.
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
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:
| Command | Description |
|---|---|
hugo server | Start dev server (hot reload) |
hugo --minify | Build production to ./public/ |
hugo server -p 8080 | Custom port |
这是 HugeGraph 官方文档网站 的源代码仓库。
如果你想查找 HugeGraph 数据库本身，请访问 apache/hugegraph。
只需 3 步即可在本地启动文档网站：
前置条件： Hugo Extended v0.95+ 和 Node.js v16+
# 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 依赖
master 创建新分支| 要求 | 说明 |
|---|---|
| 双语更新 | 修改内容时需同时更新 content/cn/ 和 content/en/ |
| PR 截图 | 提交 PR 时需附上修改前后对比截图 |
| Markdown | 文档使用 Markdown 格式，带 Hugo front matter |
查看 contribution.md 了解：
| 命令 | 说明 |
|---|---|
hugo server | 启动开发服务器（热重载） |
hugo --minify | 构建生产版本到 ./public/ |
hugo server -p 8080 | 指定端口 |
Thanks to all contributors to the HugeGraph documentation!