HUGO 中文文档

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 快速上手
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 术语表
    • 配置构建
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • Front matter (前置 matter)
    • 构建选项
    • 页面资源
    • 图片处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基模板
    • 首页模板
    • 单个模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 内嵌模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • css
    • fmt
    • go 模板
    • hugo
    • js
    • lang
    • openapi3
    • os
    • urls
    • 全局
    • 加密
    • 反射
    • 变形
    • 变换
    • 哈希
    • 图像
    • 图表函数
    • 字符串
    • 安全函数
    • 局部模板函数
    • 数学
    • 数据
    • 时间
    • 模板
    • 比较
    • 类型转换
    • 编码
    • 调试
    • 资源
    • 路径
    • 集合
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Page
    • Pager
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
    • 菜单项
    • 页面
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • Images
    • 链接
    • Passthrough
    • 表格
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo 管道
    • 本节内容
    • 简介
    • 将 Sass 编译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资产
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 故障排除
    • 本节内容
    • Audit
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • FAQs
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • Search
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitLab Pages 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
    • 托管在 Azure 静态 Web 应用上
    • 托管在 GitHub Pages 上
    • 托管在 KeyCDN 上
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
GETTING STARTED FUNDAMENTALS

目录结构

每个 Hugo 项目都是一个目录,包含有助于站点内容、结构、行为和展现的子目录。

站点框架

Hugo 在你创建新站点时会生成一个项目框架。例如,以下命令:

hugo new site my-site

会创建以下目录结构:

my-site/
├── archetypes/
│   └── default.md
├── assets/
├── content/
├── data/
├── i18n/
├── layouts/
├── static/
├── themes/
└── hugo.toml         <-- 站点配置

根据需求,你可能希望将站点配置组织到子目录中:

my-site/
├── archetypes/
│   └── default.md
├── assets/
├── config/           <-- 站点配置
│   └── _default/
│       └── hugo.toml
├── content/
├── data/
├── i18n/
├── layouts/
├── static/
└── themes/

当你构建站点时,Hugo 会创建一个 public 目录,通常还会创建一个 resources 目录:

my-site/
├── archetypes/
│   └── default.md
├── assets/
├── config/       
│   └── _default/
│       └── hugo.toml
├── content/
├── data/
├── i18n/
├── layouts/
├── public/       <-- 构建站点时创建
├── resources/    <-- 构建站点时创建
├── static/
└── themes/

目录

每个子目录都为站点的內容、结构、行为或展现做出贡献。

archetypes

archetypes 目录包含新内容的模板。参见 详情 。

assets

assets 目录包含全局资源,通常通过资产管道传递。这包括图像、CSS、Sass、JavaScript 和 TypeScript 等资源。参见 详情 。

config

config 目录包含你的站点配置,可能被分成多个子目录和文件。对于配置最少的项目或不需要在不同环境中表现不同的项目,项目根目录中的单个名为 hugo.toml 的配置文件就足够了。参见 详情 。

content

content 目录包含构成站点内容的标记文件(通常是 Markdown)和页面资源。参见 详情 。

data

data 目录包含数据文件(JSON、TOML、YAML 或 XML),这些文件可以增强内容、配置、本地化和导航。参见 详情 。

i18n

i18n 目录包含多语言站点的翻译表。参见 详情 。

layouts

layouts 目录包含将内容、数据和资源转换为完整网站的模板。参见 详情 。

public

public 目录包含已发布的网站,在你运行 hugo 或 hugo server 命令时生成。Hugo 会根据需要重新创建此目录及其内容。参见 详情 。

resources

resources 目录包含 Hugo 资产管道的缓存输出,在你运行 hugo 或 hugo server 命令时生成。默认情况下,此缓存目录包含 CSS 和图像。Hugo 会根据需要重新创建此目录及其内容。

static

static 目录包含在构建站点时将复制到 public 目录的文件。例如: favicon.ico 、 robots.txt 和验证站点所有权的文件。在引入 页面捆绑包 和 资产管道 之前, static 目录也用于图像、CSS 和 JavaScript。

themes

themes 目录包含一个或多个 主题 ,每个主题都在其自己的子目录中。

联合文件系统

Hugo 创建一个联合文件系统,允许你将两个或多个目录挂载到同一个位置。例如,假设你的主目录在一个目录中包含一个 Hugo 项目,在另一个目录中包含共享内容:

home/
└── user/
    ├── my-site/            
    │   ├── content/
    │   │   ├── books/
    │   │   │   ├── _index.md
    │   │   │   ├── book-1.md
    │   │   │   └── book-2.md
    │   │   └── _index.md
    │   ├── themes/
    │   │   └── my-theme/
    │   └── hugo.toml
    └── shared-content/     
        └── films/
            ├── _index.md
            ├── film-1.md
            └── film-2.md

你可以使用挂载点在构建站点时包含共享内容。在你的站点配置中:

hugo.
     
module:
  mounts:
  - source: content
    target: content
  - source: /home/user/shared-content
    target: content
[module]
  [[module.mounts]]
    source = 'content'
    target = 'content'
  [[module.mounts]]
    source = '/home/user/shared-content'
    target = 'content'
{
   "module": {
      "mounts": [
         {
            "source": "content",
            "target": "content"
         },
         {
            "source": "/home/user/shared-content",
            "target": "content"
         }
      ]
   }
}

当你在另一个目录之上叠加一个目录时,你必须同时挂载这两个目录。

Hugo 不遵循符号链接。如果你需要符号链接提供的功能,请改用 Hugo 的联合文件系统。

挂载后,联合文件系统具有以下结构:

home/
└── user/
    └── my-site/
        ├── content/
        │   ├── books/
        │   │   ├── _index.md
        │   │   ├── book-1.md
        │   │   └── book-2.md
        │   ├── films/
        │   │   ├── _index.md
        │   │   ├── film-1.md
        │   │   └── film-2.md
        │   └── _index.md
        ├── themes/
        │   └── my-theme/
        └── hugo.toml

当两个或多个文件具有相同的路径时,优先级顺序遵循挂载顺序。例如,如果共享内容目录包含 books/book-1.md ,它将被忽略,因为项目的 content 目录先被挂载。

你可以将目录挂载到 archetypes 、 assets 、 content 、 data 、 i18n 、 layouts 和 static 。参见 详情 。

你还可以使用 Hugo 模块挂载来自 Git 仓库的目录。参见 详情 。

主题框架

Hugo 在你创建新主题时会生成一个功能性主题框架。例如,以下命令:

hugo new theme my-theme

会创建以下目录结构(未显示子目录):

my-theme/
├── archetypes/
├── assets/
├── content/
├── data/
├── i18n/
├── layouts/
├── static/
├── LICENSE
├── README.md
├── hugo.toml
└── theme.toml

使用上面描述的联合文件系统,Hugo 将这些目录中的每一个都挂载到项目中的相应位置。当两个文件具有相同的路径时,项目目录中的文件优先。这允许你,例如,通过在项目目录中的相同位置放置一个副本,来覆盖主题的模板。

如果你同时使用来自两个或多个主题或模块的组件,并且存在路径冲突,则第一个挂载点优先。

See also

  • Front matter (前置 matter)
  • js.Batch
  • 内容类型
  • 组织
  • 章节

On this page

  • 站点框架
  • 目录
  • 联合文件系统
  • 主题框架
Last updated: January 10, 2025: 添加 gtm 谷歌代码管理 (6220bf5)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays
 

Hugo Sponsors

Your Company?
 

The Hugo logos are copyright © Steve Francia 2013–2025.

The Hugo Gopher is based on an original work by Renée French.

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 快速上手
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • Hugo 模块
  • Hugo 管道
  • 命令行界面
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护