New Site Scaffolding
hugo new site example from the command line creates a directory structure with the following elements:
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.
- You can create new content files in Hugo using the
hugo newcommand. By default, Hugo will create new content files with at least
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.
- Stores all the files which need be processed by Hugo Pipes. Only the files whose
.RelPermalinkare used will be published to the
- Hugo ships with a large number of configuration directives.
The config 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.tomlfile 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.
- 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—
tutorials—you will have three directories at
content/tutorials. Hugo uses sections to assign default content types.
- 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.
- Stores templates in the form of
.htmlfiles that specify how views of your content will be rendered into a static website. Templates include list pages, your homepage, taxonomy templates, partials, single page templates, and more.
staticfolder is for verifying site ownership on Google Search Console, where you want Hugo to copy over a complete HTML file without modifying its content.
- 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.