From 379a97638778a9017e4c90daf2e91f7ef8c62e9f Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 13:57:49 -0500 Subject: [PATCH] Add docs for nav exclude --- docs/navigation-structure.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index 8114321..d966713 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -35,6 +35,18 @@ nav_order: 4 --- ``` +### Excluding pages + +For specific pages that you do not wish to include in the main navigation, e.g. a 404 page. Use the `nav_exclude: true` parameter in the YAML front matter for that page. + +```yaml +--- +layout: default +title: 404 +nav_exclude: true +--- +``` + ### Pages with children Sometimes you will want to create a page with many children (a section). To accomplish this you need to a few things. First, it is recommended that you keep pages that are related in a directory together... For example, in these docs, we keep all of the written documentation in the `./docs` directory and each of the sections in subdirectories like `./docs/ui-components` and `./docs/utilities`. This gives is an organization like: