目录结构
站点骨架
在创建新站点时,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 根据需要重建此目录及其内容。详见 详情.
- 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
您可以使用挂载(mounts)在构建站点时包含共享内容。在站点配置中:
        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"
         }
      ]
   }
}
挂载后,联合文件系统的结构如下:
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 Modules 从 Git 存储库中挂载目录。详见 详情。
主题骨架
创建新主题时,Hugo 会生成一个可用的主题骨架。例如,以下命令:
hugo new theme my-theme
会创建以下目录结构(省略了子目录):
my-theme/
├── archetypes/
├── assets/
├── content/
├── data/
├── i18n/
├── layouts/
├── static/
├── LICENSE
├── README.md
├── hugo.toml
└── theme.toml
使用上述描述的联合文件系统,Hugo 将每个目录挂载到项目的相应位置。当两个文件路径相同时,项目目录中的文件优先。这样,例如,您可以通过在项目目录相同位置放置一个副本来覆盖主题的模板。
如果您同时使用两个或多个主题或模块的组件,并且存在路径冲突,第一个挂载项优先。