diff --git a/_layouts/default.html b/_layouts/default.html index d6e6105..ae57564 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -54,7 +54,7 @@
{{ content }} - {% if page.has_children == true %} + {% if page.has_children == true and page.has_toc != false %}

Table of contents

{% assign children_list = site.pages | sort:"nav_order" %} diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index cd9de43..647856d 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -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