nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 15:57:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

added documentation for the menuTitle attribute

Browse source
This commit is contained in:
Manuel Reithuber 2017-11-19 14:48:37 +01:00
parent d335f88af4
commit 4a8d501baf
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
exampleSite/content/cont/pages/_index.en.md
View file

@ -98,6 +98,8 @@ Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-ma
# Table of content (toc) is enabled by default. Set this parameter to true to disable it. # Table of content (toc) is enabled by default. Set this parameter to true to disable it.
# Note: Toc is always disabled for chapter pages # Note: Toc is always disabled for chapter pages
disableToc = "false" disableToc = "false"
# If set, this will be used for the page's menu entry (instead of the `title` attribute)
menuTitle = ""
# The title of the page in menu will be prefixed by this HTML content # The title of the page in menu will be prefixed by this HTML content
pre = "" pre = ""
# The title of the page in menu will be postfixed by this HTML content # The title of the page in menu will be postfixed by this HTML content
@ -139,6 +141,22 @@ weight = 5
+++ +++
``` ```
### Using a custom title for menu entries
By default, **Hugo-theme-learn** will use a page's `title` attribute for the menu item (or `linkTitle` if defined).
But a page's title has to be descriptive on its own while the menu is a hierarchy.
We've added the `menuTitle` parameter for that purpose:
For example (for a page named `content/install/linux.md`):
```toml
+++
title = "Install on Linux"
menuTitle = "Linux"
+++
```
## Homepage ## Homepage
To configure your home page, you basically have three choices: To configure your home page, you basically have three choices: