Skip to content

Navigation: omit hidden pages from section index page list by using new front matter variable #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LisaFC merged 4 commits into from
Aug 16, 2021
Merged

Navigation: omit hidden pages from section index page list by using new front matter variable #648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cb8a28
Navigation: omit hidden pages from section index page list
aimeeu Aug 2, 2021
a4fb0d7
Create hide_summary front matter and exclude if true
aimeeu Aug 3, 2021
183e32e
address review feedback; fix typo
aimeeu Aug 16, 2021
6b18fc8
fix typo (and save the file!)
aimeeu Aug 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions layouts/partials/section-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
{{ $parent := .Page }}
{{ $pages := (where .Site.Pages "Section" .Section).ByWeight }}
{{ $pages = (where $pages "Type" "!=" "search") }}
{{ $pages = (where $pages ".Params.hide_summary" "!=" true) }}
{{ $pages = (where $pages "Parent.File.UniqueID" "==" $parent.File.UniqueID) }}
{{ if or $parent.Params.no_list (eq (len $pages) 0) }}
{{/* If no_list is true or we don't have subpages we don't show a list of subpages */}}
Expand Down
15 changes: 14 additions & 1 deletion userguide/content/en/docs/Adding content/navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,20 @@ description: >
---
```

To hide a page or section from the menu, set `toc_hide: true` in front matter.
To hide a page or section from the left navigation menu, set `toc_hide: true` in the front matter.

To hide a page from the section summary on a [docs section landing page]({{< ref "content#docs-section-landing-pages" >}}), set `hide_summary: true` in the front matter. If you want to hide a page from both the TOC menu and the section summary list, you need to set both `toc_hide` and `hide_summary` to `true` in the front matter.

```yaml
---
title: "My Hidden Page"
weight: 99
toc_hide: true
hide_summary: true
description: >
Page hidden from both the TOC menu and the section summary list.
---
```

### Section menu options

Expand Down