mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
87de22d746
c43daf45f Update build-options.md 3ebbfedd4 Build options: Improve readability 5091bf6a0 Improve safeHTMLAttr explanation b64cbce2e Fix description of collections.Apply 6ea264b9c netlify: Hugo 0.115.4 b42e7c542 Revert "config: Remove disableLiveReload" 35ce2290e Remove excess spaces in configuration docs 2edf761de Update listed titleCaseStyle default value 887f6fb97 config: Remove disableLiveReload c9f49fb26 Fix typo 37d8569ac Remove tools associated with Atom 871d11b72 Fix URL in postprocess docs bbb17d29f Update GitLab workflow bc53ea5ce Use sentence-style capitalization for headings 7ca578786 netlify: Hugo 0.115.3 c5e010bd0 Merge branch 'tempv0.115.3' c885604bf Remove starter kits page 4c0fe269e Update mention of Netlify CMS to Decap CMS 05067175c Consistently use file name instead of filename 763dd6404 Improve multilingual config example and descriptions e5aa61ec5 Use lowercase when referring to front matter (#2132) 7ba3d0c72 docs: Refresh docs.json de8bddedf Update description of timeout configuration value e1245d9f8 netify: Hugo 0.115.2 153a36bdf Merge branch 'tempv0.115.2' 707cec754 Fix typo in figure example in shortcodes.md 128cbe1e5 Improve taxonomy template examples 4e743ec36 Improve highlight function example f96fa6805 transpile sass: Fixes typo e4a8a21f7 Compile Sass to CSS, not SCSS c1538bd00 docs: Regenerate CLI docs bd4e33436 Add titleCaseStyle none and firstupper 6ff93d478 Update quick-start.md 5c6653cb1 Update build config examples and explanation 1458d9a43 Remove the `url` parameter 6a1e92044 netlify: Hugo 0.115.1 a9d5d6f2f Merge branch 'tempv0.115.1' 4c4882384 docs: Regen docs helper d1aa1c1f5 Add link to PowerShell vs Windows PowerShell documentation 6e3b70c21 Fix link to Git installation instructions 4f8a9ca38 Clarify resources.Copy arguments ee86dd121 Update theme dc7c305cf Update theme 60c23920b Clarify caching for resources.FromString (#2120) 5bf2fef6d netlify: Hugo 0.115.0 46bde87c5 Merge branch 'tempv0.115.0' 42cc48c16 Specify target path caching for resources.ExecuteAsTemplate (#2027) a54bf4cd0 Correct the sample code of mermaid (#2119) 8c49b06fc docs: Update permalinks documentation a4818d99b Page bundles: link to info about single vs. list page templates (#2116) 3fc7744d7 snap: Document removable media access dbd08f58a Update theme df5b88633 netlify: Hugo 0.114.1 6b859834a Fix typo 9ec92cf68 Improve Dart Sass example for Netlify 2d294ece9 Add Dart Sass installation and usage documentation 4c6b77d6c Fix placement of curly braces 897812a50 Update template-debugging.md to include a jsonify example 22bca519b Update GitHub Pages hosting instructions (#2109) a964d93ce Document math functions new in v0.114.0 (#2108) 9f4cb040e netlify: Hugo 0.114.0 55b4d9221 Merge branch 'tempv0.114.0' 93c4dcf93 docs: Regen docshelper 96f03c77f docs: Regen CLI docs 8e22a228a Clarify resource media type variables (#2106) 2652da8d4 Update transform.Unmarshal.md (#2105) 92657177a Update theme 4601c1d65 Update theme a216f3145 Merge commit '3c1deaf201a35de08d23cc58f8f03682cace3349' eed8794f5 cache: Set default cache path based on $USER git-subtree-dir: docs git-subtree-split: c43daf45fdc36c254f4274a0815ea62d4d8c37e0
91 lines
4.7 KiB
Markdown
91 lines
4.7 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: [fundamentals,getting started]
|
|
keywords: [source, organization, directories]
|
|
menu:
|
|
docs:
|
|
parent: getting-started
|
|
weight: 30
|
|
weight: 30
|
|
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 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](/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 [configuration 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: the `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/
|
|
[taxonomies]: /content-management/taxonomies/
|
|
[taxonomy templates]: /templates/taxonomy-templates/
|
|
[types]: /content-management/types/
|