HUGO
News Docs Themes Community GitHub

LinkTitle

Returns the link title of the given page.

Syntax

PAGE.LinkTitle

Returns

string

The LinkTitle method returns the linkTitle field as defined in front matter, falling back to the value returned by the Title method.

---
linkTitle: Dessert recipes
title: Seventeen delightful recipes for healthy desserts
---
+++
linkTitle = 'Dessert recipes'
title = 'Seventeen delightful recipes for healthy desserts'
+++
{
   "linkTitle": "Dessert recipes",
   "title": "Seventeen delightful recipes for healthy desserts"
}
{{ .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:

<a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>