mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
da16527896
4c1309cdf Fix broken link to front matter page (#1923) 8181fff20 Add footnote to Quick Start guide for Win users (#1922) 4fd934f61 Fix abslangurl.md (#1919) bf2c45617 Quick start guide: fix broken links (#1915) 201b568df Update theme 874db199d Hide the news stripe on front page for now aaf59e3e2 netlify: Hugo 0.107.0 79654c301 Merge branch 'tempv107' 8345e0347 docs: Regen docs helper b5b4f15f9 Add assets directory to directory structure diagram (#1917) 76dd3a82a Follow-up: improve function signatures (#1914) (#1916) 656dc72ba Improving function signatures (#1914) b715e8407 Explain how to create multilingual content (#1912) 8500ee417 Fix typo in Quick Start guide ce60bb572 Add docu for undocumented functions (#1907) 372bf5e88 Improve Quick Start tutorial 71e81ec5f Remove asciicast from site 1e56c653f Update hosting-on-cloudflare-pages.md (#1903) 1686f60b1 Adding documentation page for function 'strings.FirstUpper' (#1901) d533f7c9c Fixing typos (#1900) 2563eee45 Update multilingual.md (#1899) 2173ed799 Update theme 5591b8875 Update urls.md (#1897) 4a88890b5 netlify: Hugo 0.106.0 512879fdd docs: Regen CLI docs f74b1d87d docs: Regenerate docs helper 9feacb48f Merge commit '00c4484c7092181729f6f470805bc7d72e8ad17b' git-subtree-dir: docs git-subtree-split: 4c1309cdfe9858434684352f9d544bf0c5c9d646
96 lines
4.9 KiB
Markdown
96 lines
4.9 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
|
|
categories: [getting started,fundamentals]
|
|
keywords: [source, organization, directories]
|
|
menu:
|
|
docs:
|
|
parent: "getting-started"
|
|
weight: 50
|
|
weight: 50
|
|
sections_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/
|
|
└── config.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 `config.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/list/
|
|
[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/
|