File: LinkTitle.md

package info (click to toggle)
hugo 0.131.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 45,580 kB
  • sloc: javascript: 31,172; xml: 248; makefile: 73; sh: 42
file content (30 lines) | stat: -rw-r--r-- 864 bytes parent folder | download
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
28
29
30
---
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>
```