核心概念

什么是 Docsy？

Docsy 是一个 Hugo 主题，专为技术文档网站设计。它提供了：

• 简洁、现代的设计
• 内置的搜索功能
• 响应式布局
• 多语言支持
• 版本控制
• 深色模式

核心概念

内容组织

Docsy 鼓励使用清晰的内容组织结构：

content/
├── _index.md          # 首页
├── docs/
│   ├── _index.md      # 文档首页
│   ├── overview.md    # 概览
│   └── ...
├── blog/
│   ├── _index.md      # 博客首页
│   └── ...
└── community/
    └── _index.md      # 社区页面

页面包

Docsy 使用 Hugo 的页面包来组织内容。页面包可以包含：

• Markdown 文件
• 图片
• 其他资源

短代码

Docsy 提供了许多有用的短代码：

• blocks/cover - 封面区块
• blocks/lead - 引导区块
• blocks/feature - 功能区块
• alert - 提示框
• pageinfo - 页面信息
• tabpane - 标签页

配置

Docsy 通过 hugo.yaml 进行配置，支持：

• 多语言设置
• 搜索配置
• 导航菜单
• 侧边栏配置
• 页脚链接

最佳实践

文档编写

1. 清晰简洁 - 使用简单明了的语言
2. 结构化 - 使用标题和列表组织内容
3. 示例丰富 - 提供代码示例和截图
4. 可搜索 - 使用相关关键词

内容组织

1. 逻辑分组 - 将相关内容放在一起
2. 渐进式 - 从基础到高级
3. 交叉引用 - 链接到相关页面

资源

• Docsy 文档
• Hugo 文档
• Docsy GitHub