steve/just-the-docs
1
0
Fork 0
mirror of https://github.com/snachodog/just-the-docs.git synced 2025-04-08 04:51:23 -06:00
Code Issues Packages Projects Releases Wiki Activity

Make TOC on parent pages optional

Browse Source
This commit is contained in:
Patrick Marsceill 2018-12-16 14:27:44 -05:00
parent 309b238400
commit 555dfae410
No known key found for this signature in database
GPG Key ID: 286B93882D828F40
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_layouts/default.html
View File

@ -54,7 +54,7 @@
<div class="page-content">
{{ content }}
{% if page.has_children == true %}
{% if page.has_children == true and page.has_toc != false %}
<hr>
<h2 class="text-delta">Table of contents</h2>
{% assign children_list = site.pages | sort:"nav_order" %}

18
docs/navigation-structure.md
View File

@ -92,7 +92,6 @@ On the parent pages, add 2 YAML front matter variables:
#### Example
{: .no_toc }
```yaml
---
layout: default
@ -121,6 +120,23 @@ nav_order: 2
---
```
### Auto-generating Table of Contents
By default, all pages with children will automatically append a Table of Contents which lists the child pages after the parent page's content. To disable this auto Table of Contents, set it to false on the parent page's YAML front matter.
#### Example
{: .no_toc }
```yaml
---
layout: default
title: UI Components
nav_order: 2
has_children: true
has_toc: false
permalink: /docs/ui-components
---
```
The Buttons page appears a child of UI Components and appears second in the UI Components section.
### Children with children