Merge pull request #90 from mreithub/master

Added a `menuTitle` attribute to partials/menu.html
matcornic · Nov 19, 2017 · 0eea215 · 0eea215
2 parents 35bd911 + 4a8d501
commit 0eea215
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git 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:

diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html
@@ -103,7 +103,7 @@ <h3>{{ if not $disableShortcutsTitle}}{{ T "Shortcuts-Title"}}{{ end }}</h3>
         {{if .Params.alwaysopen}}parent{{end}}
         ">
       <a href="{{.RelPermalink}}">
-          {{safeHTML .Params.Pre}}{{.Title}}{{safeHTML .Params.Post}}
+          {{safeHTML .Params.Pre}}{{or .Params.menuTitle .LinkTitle .Title}}{{safeHTML .Params.Post}}
           {{ if $showvisitedlinks}}
             <i class="fa fa-check read-icon"></i>
           {{ end }}
@@ -139,7 +139,7 @@ <h3>{{ if not $disableShortcutsTitle}}{{ T "Shortcuts-Title"}}{{ end }}</h3>
     {{ if not .Params.Hidden }}
       <li data-nav-id="{{.URL}}" title="{{.Title}}" class="dd-item {{if eq .UniqueID $currentNode.UniqueID}}active{{end}}">
         <a href="{{ .RelPermalink}}">
-        {{safeHTML .Params.Pre}}{{.Title}}{{safeHTML .Params.Post}}
+        {{safeHTML .Params.Pre}}{{or .Params.menuTitle .LinkTitle .Title}}{{safeHTML .Params.Post}}
         {{ if $showvisitedlinks}}<i class="fa fa-check read-icon"></i>{{end}}
         </a>
     </li>