mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
+++
|
|
categories = ["explanation"]
|
|
description = "Your site's directory structure"
|
|
title = "Directory Structure"
|
|
weight = 1
|
|
+++
|
|
|
|
If you've followed the [Getting Started](introduction/quickstart) guide, your directory layout will look similar to this:
|
|
|
|
````plaintext
|
|
├── 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](https://gohugo.io/getting-started/directory-structure/#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](configuration/customization/partials), 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](introduction/quickstart) guide.
|