Skip to content

Custom front matter variables

Hans5958 edited this page Jul 22, 2022 · 9 revisions

Other than the front matter variables implemented in Hugo, here are some other variables that you can use on this repository.

General

Variables in this section are available in all pages.

no_analytics

Disables analytics if it is set to true.

Example

no_analytics: true

robots_tag

Sets the value of the robots meta tag. No robots meta tag will be included if it is not defined.

Example

robots_tag: noindex

This will result this robots meta tag.

<meta name="robots" content='noindex' />

cover_image

Sets the image for og:image meta tag. For blog posts, it would also set the cover image for the article.

cover_image_alt

Sets the image for og:image:alt meta tag. For blog posts, it would also set the alternate text of the cover image for the article.

no_comments

Disables the comments if the layout has the comment section.

Example

no_comments: true

Docs only

section_site_name

Defines the i18n key that is going to be used as the site name for the section.

Example

section_site_name: Docs.SectionSiteName

This will set the site name to "Scratch Addons Docs," as defined on the i18n string files.

toc_root

Defines the root for the docs navigation. Currently only one page uses it, and may be deprecated soon.

toc_title

Defines the title shown on the docs navigation.

h1_title

Defines the title shown on the heading of the page. May contain Markdown.

Example

http://scratchaddons.com/docs/reference/addon-api/addon.self/ has the value shown below.

h1_title: "`addon.self`"