mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
a95896878f
9b494a58c Add comma in example config 1c24f672d Update multilingual.md 8bf85bfe4 Cosmetic change to test GitInfo 3b53b54f9 Update installing.md e3b8eb941 Get arolla-cocoon showcase ready for publishing 7b7931e59 Add "Cocoon Arolla showcase" c9cc7852c Add "scoop install hugo" for quick install on Windows 3037527fe Update Directory Structure following Hugo Pipes dbecb967d Add `assetDir` key to config list 488d1d034 Remove alias.txt git-subtree-dir: docs git-subtree-split: 9b494a58cd96ec42a4fc63c389c01523d144e03f
90 lines
4.2 KiB
Markdown
90 lines
4.2 KiB
Markdown
---
|
|
title: Directory Structure
|
|
linktitle: Directory Structure
|
|
description: Hugo's CLI scaffolds a project directory structure and then takes that single directory and uses it as the input to create a complete website.
|
|
date: 2017-01-02
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-03-09
|
|
categories: [getting started,fundamentals]
|
|
keywords: [source, organization, directories]
|
|
menu:
|
|
docs:
|
|
parent: "getting-started"
|
|
weight: 50
|
|
weight: 50
|
|
sections_weight: 50
|
|
draft: false
|
|
aliases: [/overview/source-directory/]
|
|
toc: true
|
|
---
|
|
|
|
## New Site Scaffolding
|
|
|
|
{{< youtube sB0HLHjgQ7E >}}
|
|
|
|
Running the `hugo new site` generator from the command line will create a directory structure with the following elements:
|
|
|
|
```
|
|
.
|
|
├── archetypes
|
|
├── assets
|
|
├── config.toml
|
|
├── content
|
|
├── data
|
|
├── layouts
|
|
├── static
|
|
└── themes
|
|
```
|
|
|
|
|
|
## Directory Structure Explained
|
|
|
|
The following is a high-level overview of each of the directories with links to each of their respective sections within the Hugo docs.
|
|
|
|
[`archetypes`](/content-management/archetypes/)
|
|
: You can create new content files in Hugo using the `hugo new` command.
|
|
By default, Hugo will create new content files with at least `date`, `title` (inferred from the file name), and `draft = true`. This saves time and promotes consistency for sites using multiple content types. You can create your own [archetypes][] with custom preconfigured front matter fields as well.
|
|
|
|
[`assets`][]
|
|
: Stores all the files which need be processed by [Hugo Pipes]({{< ref "/hugo-pipes" >}}). Only the files whose `.Permalink` or `.RelPermalink` are used will be published to the `public` directory.
|
|
|
|
[`config.toml`](/getting-started/configuration/)
|
|
: Every Hugo project should have a configuration file in TOML, YAML, or JSON format at the root. Many sites may need little to no configuration, but Hugo ships with a large number of [configuration directives][] for more granular directions on how you want Hugo to build your website.
|
|
|
|
[`content`][]
|
|
: All content for your website will live inside this directory. Each top-level folder in Hugo is considered a [content section][]. For example, if your site has three main sections---`blog`, `articles`, and `tutorials`---you will have three directories at `content/blog`, `content/articles`, and `content/tutorials`. Hugo uses sections to assign default [content types][].
|
|
|
|
[`data`](/templates/data-templates/)
|
|
: This directory is used to store configuration files that can be
|
|
used by Hugo when generating your website. You can write these files in YAML, JSON, or TOML format. In addition to the files you add to this folder, you can also create [data templates][] that pull from dynamic content.
|
|
|
|
[`layouts`][]
|
|
: Stores templates in the form of `.html` files that specify how views of your content will be rendered into a static website. Templates include [list pages][lists], your [homepage][], [taxonomy templates][], [partials][], [single page templates][singles], and more.
|
|
|
|
[`static`][]
|
|
: Stores all the static content: images, CSS, JavaScript, etc. When Hugo builds your site, all assets inside your static directory are copied over as-is. A good example of using the `static` folder is for [verifying site ownership on Google Search Console][searchconsole], where you want Hugo to copy over a complete HTML file without modifying its content.
|
|
|
|
{{% note %}}
|
|
From **Hugo 0.31** you can have multiple static directories.
|
|
{{% /note %}}
|
|
|
|
|
|
[archetypes]: /content-management/archetypes/
|
|
[configuration directives]: /getting-started/configuration/#all-variables-yaml
|
|
[`content`]: /content-management/organization/
|
|
[content section]: /content-management/sections/
|
|
[content types]: /content-management/types/
|
|
[data templates]: /templates/data-templates/
|
|
[homepage]: /templates/homepage/
|
|
[`layouts`]: /templates/
|
|
[`static`]: /content-management/static-files/
|
|
[lists]: /templates/list/
|
|
[pagevars]: /variables/page/
|
|
[partials]: /templates/partials/
|
|
[searchconsole]: https://support.google.com/analytics/answer/1142414?hl=en
|
|
[singles]: /templates/single-page-templates/
|
|
[starters]: /tools/starter-kits/
|
|
[taxonomies]: /content-management/taxonomies/
|
|
[taxonomy templates]: /templates/taxonomy-templates/
|
|
[types]: /content-management/types/
|
|
[`assets`]: {{< ref "/hugo-pipes/introduction#asset-directory" >}}
|