Templates

March 30, 2023 1 min read Docs Templates

Templates to help developers render images.

Donate

Become a backer or sponsor to support our work.

On this page

Image Template

Use images/image to render images.

1{{ partial "images/image" (dict
2  "Page" .
3  "Filename" "/path/to/image.png"
4  "Alt" "Example Image"
5) }}

Name	Context	Type	Required	Default	Since	Example
`Filename`	`-`	`string`	✓	-	-	-

The filename or URL of image.

Name	Context	Type	Required	Default	Since	Example
`Alt`	`-`	`string`	-	-	-	-

Alternative text.

Name	Context	Type	Required	Default	Since	Example
`Caption`	`-`	`string`	-	-	-	-

Figure caption.

Name	Context	Type	Required	Default	Since	Example
`Page`	`-`	`string`	-	-	-	-

The page variable for finding image resources.

Name	Context	Type	Required	Default	Since	Example
`ClassName`	`-`	`string`	-	`img-fluid`	-	-

The class name of <img>.

Name	Context	Type	Required	Default	Since	Example
`Original`	`-`	`boolean`	-	`false`	-	-

Whether to describe the original image info via data-* attributes.

Name	Context	Type	Required	Default	Since	Example
`LazyLoading`	`-`	`boolean`	-	`true`	-	-

Whether to enable lazy loading.