summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/strings/Title.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/strings/Title.md')
-rw-r--r--docs/content/en/functions/strings/Title.md32
1 files changed, 17 insertions, 15 deletions
diff --git a/docs/content/en/functions/strings/Title.md b/docs/content/en/functions/strings/Title.md
index 1e20d1f59..b7f1f9e5c 100644
--- a/docs/content/en/functions/strings/Title.md
+++ b/docs/content/en/functions/strings/Title.md
@@ -1,30 +1,32 @@
---
title: strings.Title
-linkTitle: title
-description: Converts the provided string to title case.
-categories: [functions]
+description: Returns the given string, converting it to title case.
+categories: []
keywords: []
-menu:
- docs:
- parent: functions
-function:
+action:
aliases: [title]
+ related:
+ - functions/strings/FirstUpper
+ - functions/strings/ToLower
+ - functions/strings/ToUpper
returnType: string
signatures: [strings.Title STRING]
-relatedFunctions:
- - strings.FirstUpper
- - strings.Title
- - strings.ToLower
- - strings.ToUpper
aliases: [/functions/title]
---
```go-html-template
-{{ title "table of contents (TOC)" }} → "Table of Contents (TOC)"
+{{ title "table of contents (TOC)" }} → Table of Contents (TOC)
```
-By default, Hugo adheres to the capitalization rules in the [Associated Press (AP) Stylebook]. Change your [site configuration] if you would prefer to follow the [Chicago Manual of Style], or to use Go's convention of capitalizing every word.
+By default, Hugo follows the capitalization rules published in the [Associated Press Stylebook]. Change your [site configuration] if you would prefer to:
-[Associated Press (AP) Stylebook]: https://www.apstylebook.com/
+- Follow the capitalization rules published in the [Chicago Manual of Style]
+- Capitalize the first letter of every word
+- Capitalize the first letter of the first word
+- Disable the effects of the `title` function
+
+The last option is useful if your theme uses the `title` function, and you would prefer to manually capitalize strings as needed.
+
+[Associated Press Stylebook]: https://www.apstylebook.com/
[Chicago Manual of Style]: https://www.chicagomanualofstyle.org/home.html
[site configuration]: /getting-started/configuration/#configure-title-case