github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/methods/page/OutputFormats.md
Bjørn Erik Pedersen d19ed4d4e6
Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae'
2023-12-04 15:24:01 +01:00

1.1 KiB
Raw Blame History

title description categories keywords action toc
OutputFormats Returns a slice of OutputFormat objects, each representing one of the output formats enabled for the given page.
related returnType signatures
methods/page/AlternativeOutputFormats
[]OutputFormat
PAGE.OutputFormats
true

{{% include "methods/page/_common/output-format-definition.md" %}}

The OutputFormats method on a Page object returns a slice of OutputFormat objects, each representing one of the output formats enabled for the given page. See details.

Methods

{{% include "methods/page/_common/output-format-methods.md" %}}

Example

To link to the RSS feed for the current page:

{{ with .OutputFormats.Get "rss" -}}
  <a href="{{ .RelPermalink }}">RSS Feed</a>
{{ end }}

On the site's home page, Hugo renders this to:

<a href="/index.xml">RSS Feed</a>

Please see the link to output formats section to understand the importance of the construct above.