hugo-theme-relearn/exampleSite/content/authoring/meta/_index.en.md

3.1 KiB

+++ categories = ["howto"] description = "What page meta information are available" frontmatter = ["headingPost", "headingPre", "hidden", "LastModifierDisplayName", "LastModifierEmail"] title = "Meta Information" weight = 3 +++

Page Title

The title will be used in the heading and meta information of your HTML.

A page without a title is treated as if hidden=true has been set.

{{< multiconfig fm=true >}} title = 'Example Title' {{< /multiconfig >}}

Page Description

The description is used for generating HTML meta information, in the children shortcode and in social media meta information.

If not set, the set value of your site's hugo.toml is used for the HTML meta information and social media meta information. It appears empty for the children shortcode.

{{< multiconfig fm=true >}} description = 'Some lenghty example description' {{< /multiconfig >}}

Social Media Images

The theme adds social media meta tags including feature images for the Open Graph protocol and Twitter Cards to your site. These are configured as mentioned in the linked Hugo docs.

{{< multiconfig fm=true >}} images = [ 'images/hero.png' ] {{< /multiconfig >}}

Hidden

{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} You can hide your pages from the menu by setting hidden=true.

{{% badge color="blueviolet" icon="bars" title=" " %}}Menu{{% /badge %}} For Hugo menus, you have to set params.hidden=true instead.

See how you can further configure visibility throughout your site.

{{< multiconfig fm=true >}} hidden = true {{< /multiconfig >}}

Add Icon to the Title Heading

{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} In the page front matter, add a headingPre to insert any HTML code before the title heading. You can also set headingPost to insert HTML code after the title heading.

You also may want to apply further CSS in this case.

{{< multiconfig fm=true >}} headingPre = ' ' {{< /multiconfig >}}

{{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} If you use the default layouts/partials/content-footer.html is not overridden by you, it will display authoring information, namely

{{< multiconfig fm=true >}} LastModifierDisplayName = 'Santa Claus' LastModifierEmail = 'santa@example.com' date = 2000-12-24T00:00:00-12:00 {{< /multiconfig >}}