aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/content/en/methods/page/Title.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/methods/page/Title.md')
-rw-r--r--docs/content/en/methods/page/Title.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/en/methods/page/Title.md b/docs/content/en/methods/page/Title.md
new file mode 100644
index 000000000..52e46ff44
--- /dev/null
+++ b/docs/content/en/methods/page/Title.md
@@ -0,0 +1,38 @@
+---
+title: Title
+description: Returns the title of the given page.
+categories: []
+keywords: []
+action:
+ related:
+ - methods/page/LinkTitle
+ returnType: string
+ signatures: [PAGE.Title]
+---
+
+With pages backed by a file, the `Title` method returns the `title` field as defined in front matter:
+
+{{< code-toggle file=content/about.md fm=true >}}
+title = 'About us'
+{{< /code-toggle >}}
+
+```go-html-template
+{{ .Title }} → About us
+```
+
+With section pages not backed by a file, the `Title` method returns the section name, pluralized and converted to title case.
+
+To disable [pluralization]:
+
+{{< code-toggle file=hugo >}}
+pluralizeListTitles = false
+{{< /code-toggle >}}
+
+To change the [title case style], specify one of `ap`, `chicago`, `go`, `firstupper`, or `none`:
+
+{{< code-toggle file=hugo >}}
+titleCaseStyle = "ap"
+{{< /code-toggle >}}
+
+[pluralization]: /functions/inflect/pluralize
+[title case style]: /getting-started/configuration/#configure-title-case