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
161 lines
6.3 KiB
Markdown
161 lines
6.3 KiB
Markdown
---
|
|
title: Content organization
|
|
linkTitle: Organization
|
|
description: Hugo assumes that the same structure that works to organize your source content is used to organize the rendered site.
|
|
categories: [fundamentals,content management]
|
|
keywords: [sections,content,organization,bundle,resources]
|
|
menu:
|
|
docs:
|
|
parent: content-management
|
|
weight: 20
|
|
toc: true
|
|
weight: 20
|
|
aliases: [/content/sections/]
|
|
---
|
|
|
|
## Page bundles
|
|
|
|
Hugo `0.32` announced page-relative images and other resources packaged into `Page Bundles`.
|
|
|
|
These terms are connected, and you also need to read about [Page Resources](/content-management/page-resources) and [Image Processing](/content-management/image-processing) to get the full picture.
|
|
|
|
{{< imgproc 1-featured Resize "300x" >}}
|
|
The illustration shows three bundles. Note that the home page bundle cannot contain other content pages, although other files (images etc.) are allowed.
|
|
{{< /imgproc >}}
|
|
|
|
|
|
{{% note %}}
|
|
The bundle documentation is a **work in progress**. We will publish more comprehensive docs about this soon.
|
|
{{% /note %}}
|
|
|
|
|
|
## Organization of content source
|
|
|
|
In Hugo, your content should be organized in a manner that reflects the rendered website.
|
|
|
|
While Hugo supports content nested at any level, the top levels (i.e. `content/<DIRECTORIES>`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections].
|
|
|
|
Without any additional configuration, the following will automatically work:
|
|
|
|
```txt
|
|
.
|
|
└── content
|
|
└── about
|
|
| └── index.md // <- https://example.com/about/
|
|
├── posts
|
|
| ├── firstpost.md // <- https://example.com/posts/firstpost/
|
|
| ├── happy
|
|
| | └── ness.md // <- https://example.com/posts/happy/ness/
|
|
| └── secondpost.md // <- https://example.com/posts/secondpost/
|
|
└── quote
|
|
├── first.md // <- https://example.com/quote/first/
|
|
└── second.md // <- https://example.com/quote/second/
|
|
```
|
|
|
|
## Path breakdown in Hugo
|
|
|
|
|
|
The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseURL = "https://example.com"` in your [site's configuration file][config].
|
|
|
|
### Index pages: `_index.md`
|
|
|
|
`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates], [taxonomy templates], [taxonomy terms templates], and your [homepage template].
|
|
|
|
{{% note %}}
|
|
**Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/).
|
|
{{% /note %}}
|
|
|
|
You can create one `_index.md` for your homepage and one in each of your content sections, taxonomies, and taxonomy terms. The following shows typical placement of an `_index.md` that would contain content and front matter for a `posts` section list page on a Hugo website:
|
|
|
|
|
|
```txt
|
|
. url
|
|
. ⊢--^-⊣
|
|
. path slug
|
|
. ⊢--^-⊣⊢---^---⊣
|
|
. filepath
|
|
. ⊢------^------⊣
|
|
content/posts/_index.md
|
|
```
|
|
|
|
At build, this will output to the following destination with the associated values:
|
|
|
|
```txt
|
|
|
|
url ("/posts/")
|
|
⊢-^-⊣
|
|
baseurl section ("posts")
|
|
⊢--------^---------⊣⊢-^-⊣
|
|
permalink
|
|
⊢----------^-------------⊣
|
|
https://example.com/posts/index.html
|
|
```
|
|
|
|
The [sections] can be nested as deeply as you want. The important thing to understand is that to make the section tree fully navigational, at least the lower-most section must include a content file. (i.e. `_index.md`).
|
|
|
|
|
|
### Single pages in sections
|
|
|
|
Single content files in each of your sections will be rendered as [single page templates][singles]. Here is an example of a single `post` within `posts`:
|
|
|
|
|
|
```txt
|
|
path ("posts/my-first-hugo-post.md")
|
|
. ⊢-----------^------------⊣
|
|
. section slug
|
|
. ⊢-^-⊣⊢--------^----------⊣
|
|
content/posts/my-first-hugo-post.md
|
|
```
|
|
|
|
When Hugo builds your site, the content will be output to the following destination:
|
|
|
|
```txt
|
|
|
|
url ("/posts/my-first-hugo-post/")
|
|
⊢------------^----------⊣
|
|
baseurl section slug
|
|
⊢--------^--------⊣⊢-^--⊣⊢-------^---------⊣
|
|
permalink
|
|
⊢--------------------^---------------------⊣
|
|
https://example.com/posts/my-first-hugo-post/index.html
|
|
```
|
|
|
|
|
|
## Paths explained
|
|
|
|
The following concepts provide more insight into the relationship between your project's organization and the default Hugo behavior when building output for the website.
|
|
|
|
### `section`
|
|
|
|
A default content type is determined by the section in which a content item is stored. `section` is determined by the location within the project's `content` directory. `section` *cannot* be specified or overridden in front matter.
|
|
|
|
### `slug`
|
|
|
|
The `slug` is the last segment of the URL path, defined by the file name and optionally overridden by a `slug` value in front matter. See [URL Management](/content-management/urls/#slug) for details.
|
|
|
|
### `path`
|
|
|
|
A content's `path` is determined by the section's path to the file. The file `path`
|
|
|
|
* is based on the path to the content's location AND
|
|
* does not include the slug
|
|
|
|
### `url`
|
|
|
|
The `url` is the entire URL path, defined by the file path and optionally overridden by a `url` value in front matter. See [URL Management](/content-management/urls/#slug) for details.
|
|
|
|
[config]: /getting-started/configuration/
|
|
[formats]: /content-management/formats/
|
|
[front matter]: /content-management/front-matter/
|
|
[getpage]: /functions/getpage/
|
|
[homepage template]: /templates/homepage/
|
|
[homepage]: /templates/homepage/
|
|
[lists]: /templates/lists/
|
|
[pretty]: /content-management/urls/#appearance
|
|
[section templates]: /templates/section-templates/
|
|
[sections]: /content-management/sections/
|
|
[singles]: /templates/single-page-templates/
|
|
[taxonomy templates]: /templates/taxonomy-templates/
|
|
[taxonomy terms templates]: /templates/taxonomy-templates/
|
|
[types]: /content-management/types/
|
|
[urls]: /content-management/urls/
|