thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2025-01-03 10:26:38 -05:00
Code Issues Projects Releases Wiki Activity

Recommend using index.md as parent page for sections

Browse Source 
Using `index.md` as name for the parent page within a section allows lazy developers
to skip defining `permalink`. This is already working and this PR just updates the documentation.
This commit is contained in:
Manu 2019-08-15 09:36:20 +08:00
parent 418cf1d640
commit de37d60720
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/navigation-structure.md
View File

@ -67,7 +67,7 @@ Sometimes you will want to create a page with many children (a section). First,
| |
|-- docs |-- docs
| |-- ui-components | |-- ui-components
| | |-- ui-components.md (parent page) | | |-- index.md (parent page)
| | |-- buttons.md | | |-- buttons.md
| | |-- code.md | | |-- code.md
| | |-- labels.md | | |-- labels.md
@ -75,7 +75,7 @@ Sometimes you will want to create a page with many children (a section). First,
| | +-- typography.md | | +-- typography.md
| | | |
| |-- utilities | |-- utilities
| | |-- utilities.md (parent page) | | |-- index.md (parent page)
| | |-- color.md | | |-- color.md
| | |-- layout.md | | |-- layout.md
| | |-- responsive-modifiers.md | | |-- responsive-modifiers.md
@ -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) - `has_children: true` (tells us that this is a parent page)
- `permalink:` set this to the site directory that contains the child pages
#### Example #### Example
{: .no_toc } {: .no_toc }
@ -101,7 +100,6 @@ layout: default
title: UI Components title: UI Components
nav_order: 2 nav_order: 2
has_children: true has_children: true
permalink: /docs/ui-components
--- ---
``` ```
@ -140,7 +138,6 @@ title: UI Components
nav_order: 2 nav_order: 2
has_children: true has_children: true
has_toc: false has_toc: false
permalink: /docs/ui-components
--- ---
``` ```