Skip to content

Commit

Permalink
Merge pull request #181 from m3nu/master
Browse files Browse the repository at this point in the history
Recommend using index.md as parent page for sections
  • Loading branch information
pmarsceill committed Sep 9, 2019
2 parents ea9affe + de37d60 commit 34eaf8b
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/navigation-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ Sometimes you will want to create a page with many children (a section). First,
|
|-- docs
| |-- ui-components
| | |-- ui-components.md (parent page)
| | |-- index.md (parent page)
| | |-- buttons.md
| | |-- code.md
| | |-- labels.md
| | |-- tables.md
| | +-- typography.md
| |
| |-- utilities
| | |-- utilities.md (parent page)
| | |-- index.md (parent page)
| | |-- color.md
| | |-- layout.md
| | |-- responsive-modifiers.md
Expand All @@ -88,9 +88,8 @@ Sometimes you will want to create a page with many children (a section). First,
+-- ..
```

On the parent pages, add 2 YAML front matter parameters:
On the parent pages, add this YAML front matter parameter:
- `has_children: true` (tells us that this is a parent page)
- `permalink:` set this to the site directory that contains the child pages

#### Example
{: .no_toc }
Expand All @@ -101,7 +100,6 @@ layout: default
title: UI Components
nav_order: 2
has_children: true
permalink: /docs/ui-components
---
```

Expand Down Expand Up @@ -140,7 +138,6 @@ title: UI Components
nav_order: 2
has_children: true
has_toc: false
permalink: /docs/ui-components
---
```

Expand Down

0 comments on commit 34eaf8b

Please sign in to comment.