Theme for Hugo static site generator created initially for my personal blog
I've started to tag the releases. The first tagged release is v0.1.0 and it's for using with hugo v0.15.0.
I expect to be bumping minor versions for new features and breaking changes until I decide to launch the first version v1.0.0, as semversion defines, and I will track the Hugo version which the versions of this theme target.
| Theme Version | Hugo Version |
|---|---|
| v0.5.0 | v0.15 |
So far the theme only uses one environment variable, HUGO_DEV, to enable and disable content to render.
If the variable exists and has a value different than an empty string then it is considered that Hugo is rendered for a development environment and those parts which aren't wanted for development will be disabled.
The clear example of the usage of this variable is to render or not the Google Analytics snippet to avoid to collect analytics when the site is running in a development environment.
This section contains the parameters required and available to set in Hugo site configuration and other files
This options are set in the site's configuration file (config.tmol|json|yml)
- locale: The locale of your site; it's recommended to use a full locale (lang_variant); the theme get the first two characters of this value to set
langattribute inhtmltag and use the whole value for locale open graph property value. - subtitle: The short text that must introduce your site which sits under the title
- description: Text which describe your site; it's used as a value for
descriptionmeta tag and open graph description property - disqus_shortname (optional): The disqus short name to use; if it exists disqus will be embedded by pages using "layouts/_defaults/single.html" otherwise it disqus won't be embedded.
- author_name: The name to use to show as the author of the site
- author_url (optional): An URL to use in some places as a link to point author's name (authorName). If it isn't provided then the author's name would be used without any link
- social_image (optional): Site wide value, see the description in custom page paremets section
- twitter_username: Site wide value, see the description in custom page paremets section
- canonical: Used to change the default canonical URL (
href) from tag<link rel="canonical href="..., defaultPermalinkis used. - social_profiles (optional): List of social profiles which will be used to render the links to it, each element is a map with the following keys. There isn't maximum, however the template should be checked for 4 at most.
- name: A text to use for the content of the links
- description: A extended text to use as "title" attribute value in the html elements
- url: The URL to the social profile
- Header partial
- canonical: Used to change the default canonical URL (
href) from tag<link rel="canonical href="..., defaultPermalinkis used. - social_image (optional): Used to define the the URL (
content) of<meta name="og:image content="...and<meta name="twitter:image content=".... Its content is defined bysocial_imageparameter defined config.toml (.Site.Params) for "nodes" and in Front Matter parameters for "pages", however:- For "nodes" only
og:imagemeta tag is added when parameter is defined in config.toml otherwise is omitted. - For "pages" when parameter is not defined in Front Matter the meta tag
twitter:imageis omitted and the meta tagog:imagedefaults to the value config.toml if exist otherwise it's omitted.
- For "nodes" only
- section: If it's set then is used for the value (
content) of<meta name=og:section content="...otherwise the tag is omitted - last_update_date: If it's set then is used for the value (
content) of<meta name="og:modified_time content="..., otherwise.PublishDateis used
This theme contains several shortcodes. The current available ones have been imported from hugo-resources repo and they are documented in the repo site.
MIT read LICENSE file for more information.