Frontmatter

Custom Axiom Frontmatter fields for Hugo.

Private

Exclude a piece of Content from Robots indexing, Sitemaps, and Feeds.

+++
private = true
+++

Useful for Pages such as 404, Privacy Policy, or Disclosures that you don't want indexed.

Feature

Add a Featured image to a piece of Content.

+++
# Using path plus filename
feature = "image/uploads/file.jpg"

# Using 'public_id' (uuid), instead of filename
feature = "5e39e315-c06c-4d81-9b4a-35fca661621c"
+++

Remember to output the image in the size set in the Image Config (params.image width and height) option and store it locally or on a CDN. See the Image section in the Configuration for details.

Caption

Add a Caption to a Featured image.

+++
caption = "Feature image caption and image alt text."
+++

Author

Author of the Content.

+++
# Author Id from /data/author.toml
author = "default"
+++

See the Author section in the Configuration for details.

Subtitle

Short blurb enhancing the Content's Title. Used in the Structured Data alternativeHeadline field and in Content Summaries.

+++
subtitle = "Suggested 25 words / 125 chars. Used in metadata, Post Page, and Content summaries."
+++

SEO potential, write something relevant.

Summary

Summary and Meta Description of the Content. Used in Section Pages, Summery Pages, Meta, Open-Graph, and Structured Data description fields. Affected by Hugo's Config variable summaryLength which defaults to 70.

+++
summary = "Summary, and meta description. Automatically generated by Hugo's 'Summary' function if not provided. Longer than Summary, with more detail, typically 70 words more or less."
+++

SEO potential, write something relevant.

Comments

Turn off Comments for this piece of Content.

+++
comments = false
+++

Turn on a Table of Contents (TOC) for this piece of Content.

+++
toc = true
+++

Table of Contents are a built-in part of Hugo. See the Hugo TOC documentation to learn more.

Max Width

Set the max width of Page Title, Feature, and/or Content.

+++
# Page sections
maxWidthTitle = "max-w-2xl"
maxWidthFeature = "max-w-5xl"
maxWidthContent = "max-w-2xl"

# Template parts
maxWidthHeader = "max-w-6xl"
maxWidthFooter = "max-w-6xl"
+++

The value for the max width param must be a valid CSS class name that is defined in Tailwind CSS or in Custom CSS.

Setting any of these will override the default max width value. Alternatively, you can set these in the Configuration file for a global change.

Type Chromeless

Display a Page without any "chrome", i.e., header or footer. This is useful for creating printable PDFs of a Page for download, or unwrapping a Page to iframe on another website.

+++
type = "chromeless"
# Optional custom layout, otherwise uses `layouts/page/single` layout:
# layout = "custom-layout"
+++

Docs