HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可协议
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面捆绑
    • 内容格式
    • Front matter
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学公式
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 本节内容
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pager
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 本节内容
    • 简介
    • 引用块
    • 代码块
    • 标题
    • 图片
    • 链接
    • 传递
    • 表格
  • 短代码
    • 本节内容
    • 评论
    • 详情
    • 图表
    • Gist
    • 高亮
    • Instagram
    • 参数
    • 二维码
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后处理
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • CLI
  • 故障排除
    • 本节内容
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题解答
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo Deploy
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure 静态 Web 应用上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
入门 基础知识

目录结构

每个 Hugo 项目都是一个目录,包含子目录,这些子目录为站点的贡献内容、结构、行为和展示。

站点骨架

当你创建一个新站点时,Hugo 会生成项目骨架。例如,这个命令

hugo new site my-site

创建如下目录结构

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

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

my-site/
├── archetypes/
│   └── default.md
├── assets/
├── config/           <-- site configuration
│   └── _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/       <-- created when you build your site
├── resources/    <-- created when you build your site
├── 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 将每个目录挂载到项目中对应的位置。当两个文件具有相同的路径时,项目目录中的文件具有更高的优先级。这允许您,例如,通过将副本放置在项目目录中的相同位置来覆盖主题的模板。

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

另请参阅

  • 函数
  • 评论
  • 组织
  • 内容类型
  • Front matter

在此页面

  • 网站骨架
  • 目录
  • 联合文件系统
  • 主题骨架
上次更新时间:2025 年 1 月 16 日:将目录名、文件名和文件路径格式化为代码 (8051ff818)
改进此页面
由Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

贵公司?
 

Hugo 徽标的版权归 Steve Francia 2013–2025 所有。

Hugo 地鼠基于 Renée French 的原创作品。

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 短代码
  • Hugo 模块
  • Hugo Pipes
  • CLI
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护