文档

PrimeEdge 提供文档布局，适合编写技术文档、教程和说明文档。

特点

• 侧边栏导航: 层级清晰的文档目录
• 文档首页: 展示文档概览
• 上一篇/下一篇: 文档间快速导航
• 适合长文: 支持复杂的内容结构

创建文档

文档首页

创建 content/docs/_index.md：

---
title: "文档"
description: "项目文档中心"
---

# 欢迎使用

这是文档首页，可以在这里写文档概述。

单篇文档

hugo new content docs/guide/installation.md

---
title: "安装指南"
description: "如何安装和配置"
weight: 1
---

文档结构

建议的文档组织结构：

content/docs/
├── _index.md              # 文档首页
├── getting-started/       # 入门指南
│   ├── _index.md
│   ├── installation.md
│   └── quick-start.md
├── configuration/         # 配置说明
│   ├── _index.md
│   ├── basic.md
│   └── advanced.md
├── api/                   # API 文档
│   ├── _index.md
│   └── reference.md
└── faq.md                 # 常见问题

Front Matter

---
title: "文档标题"
description: "文档描述"
weight: 1          # 排序权重，数字越小越靠前
draft: false
---

文档导航

侧边栏

文档页面的侧边栏自动根据目录结构生成：

• 显示同级文档
• 显示子目录
• 高亮当前页面

上一篇/下一篇

文档底部自动显示相邻文档的导航链接。

文档写作建议

1. 清晰的结构: 使用标题层级组织内容
2. 代码示例: 提供可运行的代码片段
3. 截图说明: 关键步骤配合截图
4. 版本标注: 注明适用的版本信息
5. 定期更新: 保持文档与代码同步

代码块

文档中大量使用代码块：

```bash
# 安装命令
npm install package-name
```

```javascript
// 使用示例
const app = new Application();
app.start();
```

提示框

使用引用块作为提示：

> **提示**
> 这是重要的提示信息。

> **注意**
> 这是需要注意的内容。

> **警告**
> 这是警告信息，请谨慎操作。

文档模板

创建 archetypes/docs.md：

---
title: "{{ replace .Name "-" " " | title }}"
description: ""
weight: 10
draft: false
---

## 概述

简要介绍本文档的内容。

## 前提条件

使用本文档前需要了解的内容。

## 详细步骤

### 步骤一

内容...

### 步骤二

内容...

## 常见问题

### 问题一

解答...

## 参考链接

- [相关链接1](url)
- [相关链接2](url)

多版本文档

如需维护多版本文档：

content/docs/
├── v1/
│   ├── _index.md
│   └── guide.md
├── v2/
│   ├── _index.md
│   └── guide.md
└── _index.md

搜索集成

文档内容会被自动索引，支持全文搜索。

示例：API 文档

---
title: "API 参考"
description: "完整的 API 文档"
weight: 10
---

# API 参考

## 认证

所有 API 请求需要在 Header 中携带 Token：

Authorization: Bearer YOUR_TOKEN

## 用户接口

### 获取用户信息

```http
GET /api/v1/users/{id}

参数：

响应：

{
  "id": 1,
  "name": "用户名",
  "email": "user@example.com"
}

错误码

## 下一步

- [笔记](./notes/) - 快速记录想法
- [文章写作](./posts/) - 编写博客文章