5e078383a7
49809a03 Merge commit '20a631b4964fc0ab9137cce1e41774cbc17de044' 20a631b4 Squashed 'themes/gohugoioTheme/' changes from b8202f539..dafc91ff1 8b58f565 Re-generate CLI docs 4653a724 Add Netlify deployment badge 2d6246bc Remove some deprecated site variables e6777153 Improve Algolia Search Display Styling 1570999f Add missing "." in front of gitlab-ci.yaml example b922ae7d This adds documentation to the new configDir/Environment logic from .53 (#729) 7cff379f Correctly escape multi-word taxonomy terms in example 2dfeeda4 fix typo by removing stray paren 0870bd9a Fix typo in `paginate` description 91e8be85 Fixes https://github.com/gohugoio/hugo/issues/5609 c1db65ec Make the dummy URL more obvious b4589ff0 Fix a link b73dcb9a Consistently use "posts" as section name in examples 7a56abbc Format definitions a9c6fd9b Minor clarification over the last commit 5c86bdc8 Add alternative instructions for Quick Start for non-git users dafe7ee9 Add Visual Studio Code plug-ins 110ed19e Update HUGO_VERSION 2abd031a Update page.md b332f7b9 Update page.md f5a8c9d4 Update static-files.md 6d0c155c Add note about relative protocol URLs a13751ac Theme Warning: Remove note about unquoted URLs 4c8f7d68 Incorporate feedback 6f2b9cf0 Update Creating Themes Warning 40d88d98 Fix ToC example to use binary true/false 4a11f3f1 Fix typo 2dbfc0a4 Fix a typo in taxonomies d63790ef Do not mark UndocumentedFeature issues as stale d7aff095 Regenerate docs.json 71c0826f Update transform.Unmarshal.md git-subtree-dir: docs git-subtree-split: 49809a038b2691637bab7f3f2e385dde654a88b8
2.7 KiB
| title | linktitle | description | date | publishdate | lastmod | categories | keywords | menu | weight | sections_weight | draft | aliases | toc | wip | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Create a Theme | Create a Theme | The `hugo new theme` command will scaffold the beginnings of a new theme for you to get you on your way. | 2017-02-01 | 2017-02-01 | 2017-02-01 |
|
|
|
30 | 30 | false |
|
true | true |
{{% warning "Use Absolute Links" %}} If you're creating a theme with plans to share it on the Hugo Themes website please note the following:
- If using inline styles you will need to use absolute URLs, for the linked assets to be served properly, e.g.
<div style="background: url('{{ "images/background.jpg" | absURL }}')"> - Make sure not to use a forward slash
/in the beginning of aURL, because it will point to the host root. Your theme's demo will be available in a subdirectory of the Hugo website and in this scenario Hugo will not generate the correctURLfor theme assets. - If using external CSS and JS from a CDN, make sure to load these assets over
https. Please do not use relative protocol URLs in your theme's templates. {{% /warning %}}
Hugo can initialize a new blank theme directory within your existing themes using the hugo new command:
hugo new theme [name]
Theme Folders
A theme component can provide files in one or more of the following standard Hugo folders:
- layouts
- Templates used to render content in Hugo. Also see Templates Lookup Order.
- static
- Static files, such as logos, CSS and JavaScript.
- i18n
- Language bundles.
- data
- Data files.
- archetypes
- Content templates used in
hugo new.
Theme Configuration File
A theme component can also provide its own Configuration File, e.g. config.toml. There are some restrictions to what can be configured in a theme component, and it is not possible to overwrite settings in the project.
The following settings can be set:
params(global and per language)menu(global and per language)outputformatsandmediatypes
Theme Description File
In addition to the configuration file, a theme can also provide a theme.toml file that describes the theme, the author and origin etc. See Add Your Hugo Theme to the Showcase.
{{% note "Use the Hugo Generator Tag" %}}
The .Hugo.Generator tag is included in all themes featured in the Hugo Themes Showcase. We ask that you include the generator tag in all sites and themes you create with Hugo to help the core team track Hugo's usage and popularity.
{{% /note %}}