hugo-theme-relearn/exampleSite/content/configuration/sitemanagement/structure/_index.en.md
Sören Weber 7e0a04d9aa
docs: distinctively name directories #567
too much `content`
2024-10-11 22:40:14 +02:00

1.6 KiB

+++ description = "Your site's directory structure" title = "Directory Structure" weight = 1 +++

If you've followed the Getting Started guide, your directory layout will look similar to this:

├── content
│   ├── first-chapter
│   │   ├── first-page
|   |   |   └── _index.md
│   │   ├── second-page
|   |   |   └── index.md
│   │   └── third-page.md
│   └── _index.md
├── themes
│   └── hugo-theme-relearn
│       └── ...
└── hugo.toml

Hugo uses a union file system, which lets you combine multiple directories.

By default, it puts your root directory on top of the Relearn theme directory. Files in your root directory will replace theme files in the same location.

For example, if you create a file at layouts/partials/heading.html, it will override the theme's themes/hugo-theme-relearn/layouts/partials/heading.html.

See this list, to learn which files are allowed to be modified by you.

This makes it easy to customize the theme without changing files in the themes directory, making future theme updates simpler.

Warning

Don't edit files inside the themes/hugo-theme-relearn directory. That's not the recommended way to customize! Refer to the explanation above.

Don't clone the theme repository and edit files there for your site. That's not the recommended way to customize! Instead, follow the Getting Started guide.