summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/page/Description.md
blob: 5287aa69977d7dd6d830bedfa65f098d7f813a2e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
---
title: Description
description: Returns the description of the given page as defined in front matter.
categories: []
keywords: []
params:
  functions_and_methods:
    returnType: string
    signatures: [PAGE.Description]
---

Conceptually different from 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 >}}

```go-html-template {file="layouts/_default/baseof.html"}
<head>
  ...
  <meta name="description" content="{{ .Description }}">
  ...
</head>
```

[content summary]: /content-management/summaries/