mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
d3927310d5
1798dc0d5 Update theme 403fa716e Update CLI documentation (#2092) aade5a09e Correct media subtype example 53cd9dea6 netlify: Hugo 0.112.3 b78b86cb1 Add source/target warning to resources.Copy (#2091) 50c299729 netlify: Hugo 0.112.2 73197046f Change config.xxx to hugo.xxx throughout the documentation (#2090) d489d4c6f Add hugo.WorkingDir to docs (#2089) 7487df809 Fix typos (#2088) 6d0572cd6 netlify: Hugo 0.112.1 6838600b2 netlify: Hugo 0.112.0 513e7a80f Merge branch 'tempv0.112.0' 91eb44275 Some more about 0.112.0 bd3b33a27 docs: Regen docshelper fb3027daf docs: Regen CLI docs 8e7b8e987 Merge commit 'f96384a3b596f9bc0a3a035970b09b2c601f0ccb' a942ceef4 tpl/tplimpl: Add img loading attribute to figure shortcode (#10927) 0e0c7b25e tpl/urls: Return empty string when JoinPath has zero args 310ce949a tpl/urls: Add JoinPath template function ae435ca77 tpl: Add math.Abs f340139f8 Revert "Update syntax-highlighting.md (#10929)" (#10930) 917a0e24d Update syntax-highlighting.md (#10929) git-subtree-dir: docs git-subtree-split: 1798dc0d54ce048dd975863b490cd809ef14268a
92 lines
4.8 KiB
Markdown
92 lines
4.8 KiB
Markdown
---
|
|
title: 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.
|
|
categories: [getting started,fundamentals]
|
|
keywords: [source, organization, directories]
|
|
menu:
|
|
docs:
|
|
parent: getting-started
|
|
weight: 50
|
|
weight: 50
|
|
aliases: [/overview/source-directory/]
|
|
toc: true
|
|
---
|
|
|
|
## New Site Scaffolding
|
|
|
|
{{< youtube sB0HLHjgQ7E >}}
|
|
|
|
Running `hugo new site example` from the command line creates a directory structure with the following elements:
|
|
|
|
```txt
|
|
example/
|
|
├── archetypes/
|
|
│ └── default.md
|
|
├── assets/
|
|
├── content/
|
|
├── data/
|
|
├── layouts/
|
|
├── public/
|
|
├── static/
|
|
├── themes/
|
|
└── hugo.toml
|
|
```
|
|
|
|
## 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 filename), 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](/hugo-pipes/). Only the files whose `.Permalink` or `.RelPermalink` are used will be published to the `public` directory.
|
|
|
|
[`config`](/getting-started/configuration/)
|
|
: Hugo ships with a large number of [configuration directives].
|
|
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.
|
|
Projects with minimal settings and no need for environment awareness can use a single `hugo.toml` file at its 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. Note: config directory is not created by default.
|
|
|
|
[`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 %}}
|
|
|
|
[`resources`]
|
|
: 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.
|
|
|
|
[archetypes]: /content-management/archetypes/
|
|
[`assets`]: /hugo-pipes/introduction#asset-directory
|
|
[configuration directives]: /getting-started/configuration/#all-configuration-settings
|
|
[`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/
|
|
[`resources`]: /getting-started/configuration/#configure-file-caches
|
|
[lists]: /templates/lists/
|
|
[pagevars]: /variables/page/
|
|
[partials]: /templates/partials/
|
|
[searchconsole]: https://support.google.com/webmasters/answer/9008080#zippy=%2Chtml-file-upload
|
|
[singles]: /templates/single-page-templates/
|
|
[starters]: /tools/starter-kits/
|
|
[taxonomies]: /content-management/taxonomies/
|
|
[taxonomy templates]: /templates/taxonomy-templates/
|
|
[types]: /content-management/types/
|