3886fc1fef
211a3c613 Prepare the forestry.io article for release 23995d6b4 Add forestry.io to showcase 3f177c94e Fix some typos (found by codespell) dc26e0a5a Clarify the default for site config files and multiple config files c87c9c62e Review and update the Site config documentation for consistency a29edc50c Fix the default value of rssLimit site config 83f3c46b0 Minor style fix 4f860d1a2 Typo capitalization fixes 7851345c8 Add docs about comments within templates d129b4a28 Make the recommendation to use partial over template consistent 6cd260a41 Update index.md a2787e1a4 Add Let’s Encrypt showcase 7e664f69e Update configuration.md 8002120f1 Update multilingual.md 702b46a62 Add documentation for the disableLanguages setting cb3d395de Fix content type reference d33226924 Update Page Kinds documentation 8203f649d Fix misformed markdown link 19e99c957 Add Section definition git-subtree-dir: docs git-subtree-split: 211a3c6136c69f49baeae6cd35e5a8853cddf710
3.6 KiB
| title | linktitle | description | date | publishdate | lastmod | categories | keywords | menu | weight | draft | aliases | toc | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Content Sections | Sections | Hugo generates a **section tree** that matches your content. | 2017-02-01 | 2017-02-01 | 2017-02-01 |
|
|
|
50 | false |
|
true |
A Section is a collection of pages that gets defined based on the
organization structure under the content/ directory.
By default, all the first-level directories under content/ form their own
sections (root sections).
If a user needs to define a section foo at a deeper level, they need to create
a directory named foo with an _index.md file (see Branch Bundles
for more information).
{{% note %}} A section cannot be defined or overridden by a front matter parameter -- it is strictly derived from the content organization structure. {{% /note %}}
Nested Sections
The sections can be nested as deeply as you need.
content
└── blog <-- Section, because first-level dir under content/
├── funny-cats
│ ├── mypost.md
│ └── kittens <-- Section, because contains _index.md
│ └── _index.md
└── tech <-- Section, because contains _index.md
└── _index.md
The important part to understand is, that to make the section tree fully navigational, at least the lower-most section needs a content file. (e.g. _index.md).
{{% note %}}
When we talk about a section in correlation with template selection, it is
currently always the root section only (/blog/funny-cats/mypost/ => blog).
If you need a specific template for a sub-section, you need to adjust either the type or layout in front matter.
{{% /note %}}
Example: Breadcrumb Navigation
With the available section variables and methods you can build powerful navigation. One common example would be a partial to show Breadcrumb navigation:
{{< code file="layouts/partials/breadcrumb.html" download="breadcrumb.html" >}}
-
{{ template "breadcrumbnav" (dict "p1" . "p2" .) }}
Section Page Variables and Methods
Also see Page Variables.
{{< readfile file="/content/readfiles/sectionvars.md" markdown="true" >}}
Content Section Lists
Hugo will automatically create pages for each root section that list all of the content in that section. See the documentation on section templates for details on customizing the way these pages are rendered.
Content Section vs Content Type
By default, everything created within a section will use the content type that matches the root section name. For example, Hugo will assume that posts/post-1.md has a posts content type. If you are using an archetype for your posts section, Hugo will generate front matter according to what it finds in archetypes/posts.md.