Hugo文档

compose — Hugo 文档模板

作者 onweru

Compose 是一个基于 Hugo 的文档站点主题,提供简洁的导航与结构,并内置 Tina CMS 配置、图库、实时搜索、图表与 Mermaid 支持。

看看你的网站会是什么样

浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。

3 个预览视图
桌面端首页1 / 3
桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 3

截图用于了解视觉与布局,交互效果请以实际项目为准。

采集于 2026-10-02查看来源

值得关注的模板亮点

从已有项目资料中,快速了解它的特点。

01

基于 Hugo 的文档站点主题,提供简洁的导航与结构

02

随附 Tina CMS 配置,可用于内容编辑

03

内置实时搜索、语法高亮与 Mermaid 图表支持

04

支持流程图、饼图、环形图与柱状图

05

提供可搜索与可排序表格、图库及图片原生懒加载

06

exampleSite 同时作为主题的用户指南

模板详细介绍

Compose 是 onweru 开发的 Hugo 主题,定位为文档网站。README 说明它提供简洁的导航与结构,仓库中的 exampleSite 同时充当主题的用户指南,可通过 Hugo 在本地生成并预览。

功能方面,主题包含文档页面、Tina CMS 支持(随附配置)、图库、图片原生懒加载、实时搜索、流程图/饼图/环形图/柱状图、可搜索与可排序表格、语法高亮以及 Mermaid 支持。官方文档站点分主题安装、Tina CMS 使用、站点自定义、搜索配置、短代码与 Mermaid 等页面。

许可为 MIT,允许免费使用、修改、商用和分发该版本代码,分发时需保留版权声明与许可声明;演示图片、字体、图标等第三方素材需按各自许可单独核对。

Hugo文档

适合你的项目吗?

适用场景

  • 搭建产品、项目或工具的说明文档站点
  • 需要站内实时搜索与代码语法高亮的文档站
  • 希望在文档中嵌入 Mermaid 图表或流程图的站点
  • 需要图库、可搜索排序表格等展示型内容的文档站

适合人群

  • 使用 Hugo 构建文档站点的开发者
  • 需要为文档接入 Tina CMS 的团队
  • 希望在文档中展示图表与流程图的作者

上手与定制指南

结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。

  1. 1

    通过 git clone --recurse-submodules --depth 1 获取仓库,进入 exampleSite 后运行 hugo server --themesDir ../.. 可在本地预览用户指南

  2. 2

    安装、Tina CMS、自定义、搜索、短代码与 Mermaid 的说明见 composedocs.netlify.app 上的官方文档

  3. 3

    使用前请核对演示图片、字体、图标等第三方素材的许可,代码的 MIT 许可不覆盖这些素材

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本;免费范围为该版本代码,不代表外部服务或第三方素材免费。

使用时需要遵守

  • 允许免费使用、修改、商用和分发该版本代码。
  • 分发代码副本或实质性部分时,保留原作者版权声明和完整 MIT 许可声明。
  • 代码按现状提供;担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 演示图片、字体、图标及其他第三方素材需按各自许可核对,不能仅凭代码的 MIT 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
查看原文依据

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-02。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
Hugo Themes
资料与维护参考分
资料较完整 · 91 / 100
技术栈
Hugo
网站类型
文档
这个分数如何计算

本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2026-08-31
截图检查日期
2026-10-02

已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Hugo。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对;未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 1ea91968d37ccd96b8fb8bf5259dc7f170fb79d0a38f18c4de42696f713092c1

2026-10-02T15:32:21.165Z

来源文件 / 仓库
# Compose

Compose is a [Hugo](https://gohugo.io/) theme for documentation websites. The theme provides a simple navigation & structure.

![Hugo Compose Theme](https://raw.githubusercontent.com/onweru/compose/master/images/tn.png)

## Features

1. Documentation
2. Tina CMS support. Ships with configuration
3. Gallery Support
4. Native lazy loading of images
5. Live search
6. Flowcharts, Piecharts, doughnut & bar charts support
7. Searchable & Sortable tables
8. Syntax highlighting
9. Mermaid Support

## Documentation

- [Install Compose theme](https://composedocs.netlify.app/docs/compose/install-theme/)
- [Use Tina CMS](https://composedocs.netlify.app/docs/compose/use-tina-cms/)
- [Customize your site](https://composedocs.netlify.app/docs/compose/customize/)
- [Configure search](https://composedocs.netlify.app/docs/compose/search/)
- [Shortcodes](https://composedocs.netlify.app/docs/compose/shortcodes/)
- [Mermaid](https://composedocs.netlify.app/docs/compose/mermaid/)

## ExampleSite

The [exampleSite](https://github.com/onweru/compose/tree/master/exampleSite) serves as this theme's [user guide](https://composedocs.netlify.app/docs/compose/install-theme/) .

This guide covers the necessary bits. As the project evolves, the user-guide will get more comprehensive

You can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes).

```
git clone --recurse-submodules --depth 1 https://github.com/onweru/compose.git
cd compose/exampleSite/
hugo server --themesDir ../..
```

### Also built by Weru

1. [Clarity Theme](https://github.com/chipzoller/hugo-clarity)
2. [Newsroom Theme](https://github.com/onweru/newsroom)
3. [Swift Theme](https://github.com/onweru/hugo-swift-theme)
4. [Browse Theme](https://github.com/onweru/browse)

## License

This theme is available under the [MIT license](https://github.com/onweru/compose/blob/master/LICENSE).
反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。