hugo/docs/content/en/methods/page/LinkTitle.md

31 lines
863 B
Markdown
Raw Normal View History

---
title: LinkTitle
description: Returns the link title of the given page.
categories: []
keywords: []
action:
related:
- methods/page/Title
returnType: string
signatures: [PAGE.LinkTitle]
---
The `LinkTitle` method returns the `linkTitle` field as defined in front matter, falling back to the value returned by the [`Title`] method.
[`Title`]: /methods/page/title
{{< code-toggle file=content/articles/healthy-desserts.md fm=true >}}
title = 'Seventeen delightful recipes for healthy desserts'
linkTitle = 'Dessert recipes'
{{< /code-toggle >}}
```go-html-template
{{ .LinkTitle }} → Dessert recipes
```
As demonstrated above, defining a link title in front matter is advantageous when the page title is long. Use it when generating anchor elements in your templates:
```go-html-template
<a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
```