Custom output formats

This page describes how to properly configure your site with the media types and output formats, as well as where to create your templates for your custom outputs.

Media types #

A [media type] (formerly known as a MIME type) is a two-part identifier for file formats and format contents transmitted on the internet.

This is the full set of built-in media types in Hugo:

Notes:

• It is possible to add custom media types or change the defaults; e.g., if you want to change the suffix for text/html to asp.
• Suffixes are the values that will be used for URLs and file names for that media type in Hugo.
• The Type is the identifier that must be used when defining new/custom Output Formats (see below).
• The full set of media types will be registered in Hugo’s built-in development server to make sure they are recognized by the browser.

To add or modify a media type, define it in a mediaTypes section in your [site configuration], either for all sites or for a given language.

mediaTypes:
  text/enriched:
    suffixes:
    - enr
  text/html:
    suffixes:
    - asp

[mediaTypes]
  [mediaTypes.'text/enriched']
    suffixes = ['enr']
  [mediaTypes.'text/html']
    suffixes = ['asp']

{
   "mediaTypes": {
      "text/enriched": {
         "suffixes": [
            "enr"
         ]
      },
      "text/html": {
         "suffixes": [
            "asp"
         ]
      }
   }
}

The above example adds one new media type, text/enriched, and changes the suffix for the built-in text/html media type.

These media types are configured for your output formats. If you want to redefine one of Hugo’s default output formats, you also need to redefine the media type. So, if you want to change the suffix of the HTML output format from html (default) to htm:

mediaTypes:
  text/html:
    suffixes:
    - htm
outputFormats:
  html:
    mediaType: text/html

[mediaTypes]
  [mediaTypes.'text/html']
    suffixes = ['htm']
[outputFormats]
  [outputFormats.html]
    mediaType = 'text/html'

{
   "mediaTypes": {
      "text/html": {
         "suffixes": [
            "htm"
         ]
      }
   },
   "outputFormats": {
      "html": {
         "mediaType": "text/html"
      }
   }
}

Output format definitions #

Given a media type and some additional configuration, you get an Output Format.

This is the full set of Hugo’s built-in output formats:

• A page can be output in as many output formats as you want, and you can have an infinite amount of output formats defined as long as they resolve to a unique path on the file system. In the above table, the best example of this is amp vs. html. amp has the value amp for path so it doesn’t overwrite the html version; e.g. we can now have both /index.html and /amp/index.html.

• The mediaType must match a defined media type.

• You can define new output formats or redefine built-in output formats; e.g., if you want to put amp pages in a different path.

To add or modify an output format, define it in an outputFormats section in your site’s configuration file, either for all sites or for a given language.

outputFormats:
  MyEnrichedFormat:
    baseName: myindex
    isPlainText: true
    mediaType: text/enriched
    protocol: bep://

[outputFormats]
  [outputFormats.MyEnrichedFormat]
    baseName = 'myindex'
    isPlainText = true
    mediaType = 'text/enriched'
    protocol = 'bep://'

{
   "outputFormats": {
      "MyEnrichedFormat": {
         "baseName": "myindex",
         "isPlainText": true,
         "mediaType": "text/enriched",
         "protocol": "bep://"
      }
   }
}

The above example is fictional, but if used for the home page on a site with baseURL https://example.org, it will produce a plain text home page with the URL bep://example.org/myindex.enr.

Configure output formats #

Use these parameters when configuring an output format:

baseName

(string) The base name of the published file. Default is index.

isHTML

(bool) Whether to classify the output format as HTML. Hugo uses this value to determine when to create alias redirects, when to inject the LiveReload script, etc. Default is false.

isPlainText

(bool) Whether to parse templates for this output format with Go’s [text/template] package instead of the [html/template] package. Default is false.

mediaType

(string) The [media type] of the published file. This must match a defined media type, either built-in or custom.

notAlternative

(bool) Whether to exclude this output format from the values returned by the [AlternativeOutputFormats] method on a Page object. Default is false.

noUgly

(bool) Whether to disable ugly URLs for this output format when uglyURLs is true in your site configuration. Default is false.

path

(string) The path to the directory containing the published files, relative to the root of the publish directory.

permalinkable

(bool) If true, the [Permalink] and [RelPermalink] methods on a Page object return the rendering output format rather than main output format ( see below). Enabled by default for the html and amp output formats. Default is false.

protocol

(string) The protocol (scheme) of the URL for this output format. For example, https:// or webcal://. Default is the scheme of the baseURL parameter in your site configuration, typically https://.

rel

(string) If provided, you can assign this value to rel attributes in link elements when iterating over output formats in your templates. Default is alternate.

root

(bool) Whether to publish files to the root of the publish directory. Default is false.

ugly

(bool) Whether to enable uglyURLs for this output format when uglyURLs is false in your site configuration. Default is false.

weight

(int) When set to a non-zero value, Hugo uses the weight as the first criteria when sorting output formats, falling back to the name of the output format. Lighter items float to the top, while heavier items sink to the bottom. Hugo renders output formats sequentially based on the sort order.

Output formats for pages #

A Page in Hugo can be rendered to multiple output formats on the file system.

Default output formats #

Every Page has a [Kind] attribute, and the default Output Formats are set based on that.

outputs: null

{
   "outputs": null
}

Customizing output formats #

This can be changed by defining an outputs list of output formats in either the Page front matter or in the site configuration (either for all sites or per language).

Example from site configuration file:

outputs:
  home:
  - html
  - amp
  - rss
  page:
  - html

[outputs]
  home = ['html', 'amp', 'rss']
  page = ['html']

{
   "outputs": {
      "home": [
         "html",
         "amp",
         "rss"
      ],
      "page": [
         "html"
      ]
   }
}

Note that in the examples above, the output formats for section, taxonomy and term will stay at their default value ['html','rss'].

• The outputs definition is per page [Kind].
• The names (e.g. html, amp) must match the name of a defined output format, and can be overridden per page in front matter.

The following is an example of front matter in a content file that defines output formats for the rendered Page:

---
outputs:
- html
- amp
- json
title: Example
---

+++
outputs = ['html', 'amp', 'json']
title = 'Example'
+++

{
   "outputs": [
      "html",
      "amp",
      "json"
   ],
   "title": "Example"
}

List output formats #

Each Page object has both an [OutputFormats] method (all formats, including the current) and an [AlternativeOutputFormats] method, the latter of which is useful for creating a link rel list in your site’s <head>:

{{ range .AlternativeOutputFormats -}}
  <link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}">
{{ end }}

Link to output formats #

The [Permalink] and [RelPermalink] methods on a Page object return the first output format defined for that page (usually HTML if nothing else is defined). This is regardless of the template from which they are called.

From single.json.json:

{{ .RelPermalink }} → /that-page/
{{ with .OutputFormats.Get "json" }}
  {{ .RelPermalink }} → /that-page/index.json
{{ end }}

In order for them to return the output format of the current template file instead, the given output format should have its permalinkable setting set to true.

This is the same template file as above with the json output format’s permalinkable parameter set to true:

{{ .RelPermalink }} → /that-page/index.json
{{ with  .OutputFormats.Get "html" }}
  {{ .RelPermalink }} → /that-page/
{{ end }}

Template lookup order #

Each output format requires a template conforming to the [template lookup order].

For the highest specificity in the template lookup order, include the page kind, output format, and suffix in the file name:

[page kind].[output format].[suffix]

For example, for section pages: