HUGO

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
gohugoio Star
  • About Hugo
    • Overview
    • What is Hugo
    • Hugo features
    • Static site generators
    • Hugo's security model
    • Hugo and the GDPR
    • License
  • Installation
    • Overview
    • macOS
    • Linux
    • Windows
    • BSD
  • Getting started
    • Overview
    • Quick start
    • Basic usage
    • Directory structure
    • Configuration
    • Configure markup
    • Glossary of terms
    • External learning resources
  • Quick reference
    • Overview
    • Emojis
    • Functions
    • Methods
    • Page collections
  • Content management
    • Overview
    • Organization
    • Page bundles
    • Content formats
    • Front matter
    • Build options
    • Page resources
    • Image processing
    • Shortcodes
    • Related content
    • Sections
    • Content types
    • Archetypes
    • Taxonomies
    • Summaries
    • Links and cross references
    • URL management
    • Menus
    • Static files
    • Table of contents
    • Comments
    • Multilingual
    • Markdown attributes
    • Syntax highlighting
    • Diagrams
    • Mathematics
  • Templates
    • Overview
    • Templating
    • Template lookup order
    • Base templates and blocks
    • Single page templates
    • List templates
    • Homepage template
    • Section templates
    • Taxonomy templates
    • Pagination
    • Content view templates
    • Partial templates
    • Shortcode templates
    • Menu templates
    • Data templates
    • RSS templates
    • Sitemap templates
    • Internal templates
    • Custom output formats
    • 404 page
    • Robots.txt
  • Functions
    • Overview
    • cast
    • collections
    • compare
    • crypto
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • Methods
    • Overview
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • Render hooks
    • Overview
    • Introduction
    • Code blocks
    • Headings
    • Images
    • Links
  • Hugo Modules
    • Overview
    • Configure Hugo modules
    • Use Hugo Modules
    • Theme components
  • Hugo Pipes
    • Overview
    • Introduction
    • Transpile Sass to CSS
    • PostCSS
    • PostProcess
    • JavaScript building
    • Babel
    • Asset minification
    • Concatenating assets
    • Fingerprinting and SRI hashing
    • Resource from string
    • Resource from template
  • CLI
  • Troubleshooting
    • Overview
    • Audit
    • Logging
    • Inspection
    • Deprecation
    • Performance
    • FAQs
  • Developer tools
    • Overview
    • Editor plugins
    • Front-ends
    • Search
    • Migrations
    • Other projects
  • Hosting and deployment
    • Overview
    • Hugo Deploy
    • Deploy with Rclone
    • Deploy with Rsync
    • Host on 21YunBox
    • Host on AWS Amplify
    • Host on Azure Static Web Apps
    • Host on Cloudflare Pages
    • Host on Firebase
    • Host on GitHub Pages
    • Host on GitLab Pages
    • Host on KeyCDN
    • Host on Netlify
    • Host on Render
  • Contribute
    • Overview
    • Development
    • Documentation
    • Themes
  • Maintenance
METHODS PAGE METHODS

Render

Renders the given template with the given page as context.

Syntax

PAGE.Render NAME

Returns

template.HTML

Typically used when ranging over a page collection, the Render method on a Page object renders the given template, passing the given page as context.

{{ range site.RegularPages }}
  <h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
  {{ .Render "summary" }}
{{ end }}

In the example above, note that the template (“summary”) is identified by its file name without directory or extension.

Although similar to the partial function, there are key differences.

Render method partial function
The Page object is automatically passed to the given template. You cannot pass additional context. You must specify the context, allowing you to pass a combination of objects, slices, maps, and scalars.
The path to the template is determined by the content type. You must specify the path to the template, relative to the layouts/partials directory.

Consider this layout structure:

layouts/
├── _default/
│   ├── baseof.html
│   ├── home.html
│   ├── li.html      <-- used for other content types
│   ├── list.html
│   ├── single.html
│   └── summary.html
└── books/
    ├── li.html      <-- used when content type is "books"
    └── summary.html

And this template:

<ul>
  {{ range site.RegularPages.ByDate }}
    {{ .Render "li" }}
  {{ end }}
</ul>

When rendering content of type “books” the Render method calls:

layouts/books/li.html

For all other content types the Render methods calls:

layouts/_default/li.html

See content views for more examples.

See also

  • partials.Include
  • partials.IncludeCached

In this section

  • Aliases
  • AllTranslations
  • AlternativeOutputFormats
  • Ancestors
  • BundleType
  • CodeOwners
  • Content
  • CurrentSection
  • Data
  • Date
  • Description
  • Draft
  • Eq
  • ExpiryDate
  • File
  • FirstSection
  • Fragments
  • FuzzyWordCount
  • GetPage
  • GetTerms
  • GitInfo
  • HasMenuCurrent
  • HasShortcode
  • HeadingsFiltered
  • InSection
  • IsAncestor
  • IsDescendant
  • IsHome
  • IsMenuCurrent
  • IsNode
  • IsPage
  • IsSection
  • IsTranslated
  • Keywords
  • Kind
  • Language
  • Lastmod
  • Layout
  • Len
  • LinkTitle
  • Next
  • NextInSection
  • OutputFormats
  • Page
  • Pages
  • Paginate
  • Paginator
  • Param
  • Params
  • Parent
  • Path
  • Permalink
  • Plain
  • PlainWords
  • Prev
  • PrevInSection
  • PublishDate
  • RawContent
  • ReadingTime
  • Ref
  • RegularPages
  • RegularPagesRecursive
  • RelPermalink
  • RelRef
  • Render
  • RenderShortcodes
  • RenderString
  • Resources
  • Scratch
  • Section
  • Sections
  • Site
  • Sitemap
  • Sites
  • Slug
  • Store
  • Summary
  • TableOfContents
  • Title
  • TranslationKey
  • Translations
  • Truncated
  • Type
  • Weight
  • WordCount
Last updated: February 3, 2024: Replace links to variable pages with links to method pages (126c323d)
Improve this page
By the Hugo Authors
Hugo Logo
  • File an Issue
  • Get Help
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo Sponsors

 

The Hugo logos are copyright © Steve Francia 2013–2024.

The Hugo Gopher is based on an original work by Renée French.

  • News
  • Docs
  • Themes
  • Showcase
  • Community
  • GitHub
  • About Hugo
  • Installation
  • Getting started
  • Quick reference
  • Content management
  • Templates
  • Functions
  • Methods
  • Render hooks
  • Hugo Modules
  • Hugo Pipes
  • CLI
  • Troubleshooting
  • Developer tools
  • Hosting and deployment
  • Contribute
  • Maintenance