If you've built a Hugo theme and want to contribute back to the Hugo Community, add your theme to the Hugo Showcase.

2017-02-01

2017-02-01

2017-02-27

contribute

contribute

themes

design

digitalcraftsman

docs

parent

weight

contribute

30

30

30

false

/contribute/theme/

true

true

A collection of all themes created by the Hugo community, including screenshots and demos, can be found at https://themes.gohugo.io. Every theme in this list will automatically be added to the theme site. Theme updates aren't scheduled but usually happen at least once a week.

Adding a theme to the list

Add a theme.toml file to the root of the theme with all required metadata

Add a descriptive README.md to the root of the theme source

Add /images/screenshot.png and /images/tn.png

* If your theme doesn't fit into the Hugo Basic Example site, we encourage theme authors to supply a self-contained Hugo site in /exampleSite/, but note that for security reasons the content directory on the Hugo showcase will still be published from the Hugo Basic Example repository.

{{% note %}}
The folder name here---exampleSite---is important, as this folder will be picked up and used by the script that generates the Hugo Theme Site. It mirrors the root directory of a Hugo website and allows you to add custom content, assets, and a config file with preset values.
{{% /note %}}

General information about the theme in your GitHub repository (i.e., it's usual purpose, features and instructions)

{{% note "Screenshots in your README.md"%}}
If you add screenshots to the README, please make use of absolute file paths instead of relative ones like /images/screenshot.png. Relative paths work great on GitHub but they don't correspond to the directory structure of themes.gohugo.io. Therefore, browsers will not be able to display screenshots on the theme site under the given (relative) path.
{{% /note %}}