directory-structure.md (4952B)
1 ---
2 title: Directory Structure
3 linktitle: Directory Structure
4 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.
5 date: 2017-01-02
6 publishdate: 2017-02-01
7 lastmod: 2017-03-09
8 categories: [getting started,fundamentals]
9 keywords: [source, organization, directories]
10 menu:
11 docs:
12 parent: "getting-started"
13 weight: 50
14 weight: 50
15 sections_weight: 50
16 draft: false
17 aliases: [/overview/source-directory/]
18 toc: true
19 ---
20
21 ## New Site Scaffolding
22
23 {{< youtube sB0HLHjgQ7E >}}
24
25 Running the `hugo new site` generator from the command line will create a directory structure with the following elements:
26
27 ```
28 .
29 ├── archetypes
30 ├── config.toml
31 ├── content
32 ├── data
33 ├── layouts
34 ├── static
35 └── themes
36 ```
37
38
39 ## Directory Structure Explained
40
41 The following is a high-level overview of each of the directories with links to each of their respective sections within the Hugo docs.
42
43 [`archetypes`](/content-management/archetypes/)
44 : You can create new content files in Hugo using the `hugo new` command.
45 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.
46
47 [`assets`][]
48 : 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. Note: assets directory is not created by default.
49
50 [`config`](/getting-started/configuration/)
51 : Hugo ships with a large number of [configuration directives][].
52 The [config directory](/getting-started/configuration/#configuration-directory) is where those directives are stored as JSON, YAML, or TOML files. Every root setting object can stand as its own file and structured by environments.
53 Projects with minimal settings and no need for environment awareness can use a single `config.toml` file at its root.
54
55 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. Note: config directory is not created by default.
56
57 [`content`][]
58 : 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][].
59
60 [`data`](/templates/data-templates/)
61 : This directory is used to store configuration files that can be
62 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.
63
64 [`layouts`][]
65 : 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.
66
67 [`static`][]
68 : 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.
69
70 {{% note %}}
71 From **Hugo 0.31** you can have multiple static directories.
72 {{% /note %}}
73
74 resources
75 : Caches some files to speed up generation. Can be also used by template authors to distribute built SASS files, so you don't have to have the preprocessor installed. Note: resources directory is not created by default.
76
77
78 [archetypes]: /content-management/archetypes/
79 [configuration directives]: /getting-started/configuration/#all-configuration-settings
80 [`content`]: /content-management/organization/
81 [content section]: /content-management/sections/
82 [content types]: /content-management/types/
83 [data templates]: /templates/data-templates/
84 [homepage]: /templates/homepage/
85 [`layouts`]: /templates/
86 [`static`]: /content-management/static-files/
87 [lists]: /templates/list/
88 [pagevars]: /variables/page/
89 [partials]: /templates/partials/
90 [searchconsole]: https://support.google.com/analytics/answer/1142414?hl=en
91 [singles]: /templates/single-page-templates/
92 [starters]: /tools/starter-kits/
93 [taxonomies]: /content-management/taxonomies/
94 [taxonomy templates]: /templates/taxonomy-templates/
95 [types]: /content-management/types/
96 [`assets`]: {{< ref "/hugo-pipes/introduction#asset-directory" >}}