98293eaa15
f59b3ab06 Fix typo in template lookup order 1e5536d6c Mutlilingual: Document "content directory per language" system (#509) 849a86048 Update index.md 0c24d229b Polish Hugo Next a4c9b0ee2 Polish bbec2c76e Some more in birthday post fc9681e21 More on contributors 09fe3ea31 Some more on the birthday post 8da357240 Content and images for the 5th birthday blog post fb45bb8dc Add draft for anniversary blog post 4666d0a18 Release 0.42.2 9b74d286a Merge branch 'temp422' 354e7b66b releaser: Add release notes to /docs for release of 0.42.2 57a617f34 releaser: Bump versions for release of 0.42.2 ccc3ac1b8 Update errorf.md 35706c21a Update errorf.md 1c0f35fd1 Update errorf.md b6170774b Add syntax highlighting gallery links for Chroma f91d9da47 Update usage.md c9a8f0190 Improve theme components documentation 3c4e39ddd Release 0.42.1 b45eb453f Merge branch 'temp421' c74682a10 releaser: Prepare repository for 0.43-DEV 321e07fa5 releaser: Add release notes to /docs for release of 0.42.1 7154271e0 releaser: Bump versions for release of 0.42.1 360d8244f Add link to Privacy Config 1f2454247 Fix typo a8f5f994e Fix typo d9f3f078c Update simple variants documentation (#500) f5cfd44e0 Release 0.42 fe604b321 releaser: Prepare repository for 0.43-DEV c3e5b3ca0 releaser: Add release notes to /docs for release of 0.42 3174d1b37 releaser: Bump versions for release of 0.42 48cc2d51f docs: Update theme documentation 1922fb1a6 docs: Remove some files now moved d7e4c453a Merge commit 'b239595af5a9fc1fc9a1ccc666c3ab06ccc32f04' c40964c1b tplimpl: Remove speakerdeck shortcode 081f8a0f9 tpl/strings: strings.RuneCount 828ea5f15 tpl: Add strings.Repeat a6b9f654a Add a BlackFriday option for rel="noreferrer" on external links edb786516 Add a BlackFriday option for rel="nofollow" on external links e4374971f releaser: Prepare repository for 0.42-DEV git-subtree-dir: docs git-subtree-split: f59b3ab06f282c26bce07263c8be6672cf8f7969
2.3 KiB
| title | linktitle | description | date | categories | keywords | menu | weight | sections_weight | draft | aliases | toc | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Theme Components | Theme Components | Hugo provides advanced theming support with Theme Components. | 2017-02-01 |
|
|
|
20 | 20 | false |
|
true |
Since Hugo 0.42 a project can configure a theme as a composite of as many theme components you need:
{{< code-toggle file="config">}} theme = ["my-shortcodes", "base-theme", "hyde"] {{< /code-toggle >}}
You can even nest this, and have the theme component itself include theme components in its own config.toml (theme inheritance).1
The theme definition example above in config.toml creates a theme with 3 theme components with precedence from left to right.
For any given file, data entry, etc., Hugo will look first in the project and then in my-shortcode, base-theme, and lastly hyde.
Hugo uses two different algorithms to merge the filesystems, depending on the file type:
- For
i18nanddatafiles, Hugo merges deeply using the translation id and data key inside the files. - For
static,layouts(templates), andarchetypesfiles, these are merged on file level. So the left-most file will be chosen.
The name used in the theme definition above must match a folder in /your-site/themes, e.g. /your-site/themes/my-shortcodes. There are plans to improve on this and get a URL scheme so this can be resolved automatically.
Also note that a component that is part of a theme can have its own configuration file, e.g. config.toml. There are currently some restrictions to what a theme component can configure:
params(global and per language)menu(global and per language)outputformatsandmediatypes
The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts.
-
Including theme components in the themes is currently not supported for themes hosted on The Hugo Themes Site, but can be really useful if you want to create your own theme based on a theme you find on that site. ↩︎