hugo/content/en/methods/page/Description.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

28 lines
728 B
Markdown

---
title: Description
description: Returns the description of the given page as defined in front matter.
categories: []
keywords: []
action:
related:
- methods/page/Summary
returnType: string
signatures: [PAGE.Description]
---
Conceptually different that a [content summary], a page description is typically used in metadata about the page.
{{< code-toggle file=content/recipes/sushi.md fm=true >}}
title = 'How to make spicy tuna hand rolls'
description = 'Instructions for making spicy tuna hand rolls.'
{{< /code-toggle >}}
{{< code file=layouts/baseof.html >}}
<head>
...
<meta name="description" content="{{ .Description }}">
...
</head>
{{< /code >}}
[content summary]: /content-management/summaries