From 4a8d501baf2c6ed39e81336967525b79cf7e07e3 Mon Sep 17 00:00:00 2001 From: Manuel Reithuber Date: Sun, 19 Nov 2017 14:48:37 +0100 Subject: [PATCH] added documentation for the `menuTitle` attribute --- exampleSite/content/cont/pages/_index.en.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/exampleSite/content/cont/pages/_index.en.md b/exampleSite/content/cont/pages/_index.en.md index e12e6fba45..e2ff25d324 100644 --- a/exampleSite/content/cont/pages/_index.en.md +++ b/exampleSite/content/cont/pages/_index.en.md @@ -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. # Note: Toc is always disabled for chapter pages 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 pre = "" # 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 To configure your home page, you basically have three choices: