目录结构
站点框架
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
你可以使用挂载点在构建站点时包含共享内容。在你的站点配置中:
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"
         }
      ]
   }
}
挂载后,联合文件系统具有以下结构:
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
你可以将目录挂载到 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 将这些目录中的每一个都挂载到项目中的相应位置。当两个文件具有相同的路径时,项目目录中的文件优先。这允许你,例如,通过在项目目录中的相同位置放置一个副本,来覆盖主题的模板。
如果你同时使用来自两个或多个主题或模块的组件,并且存在路径冲突,则第一个挂载点优先。