Add "Enable TOC by default"

closes #116
toshimaru · Oct 25, 2020 · c232b16 · c232b16
1 parent 105d827
commit c232b16
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@
 - [Customization](#customization)
   - [Default Configuration](#default-configuration)
   - [TOC levels](#toc-levels)
+  - [Enable TOC by default](#enable-toc-by-default)
   - [Skip TOC](#skip-toc)
   - [Skip TOC Sectionally](#skip-toc-sectionally)
   - [CSS Styling](#css-styling)
@@ -173,6 +174,19 @@ toc:
 
 The default heading range is from `<h1>` to `<h6>`.
 
+### Enable TOC by default
+
+You can enable TOC by default with [Front Matter Defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/):
+
+```yml
+# _config.yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      toc: true
+```
+
 ### Skip TOC
 
 The heading is ignored in the toc by adding `no_toc` class.