From 05ce9684825434c5c2da1e4fa6d6c8eeb8386460 Mon Sep 17 00:00:00 2001 From: Cassandra Targett Date: Thu, 12 Oct 2017 09:50:58 -0500 Subject: [PATCH] Ref Guide: fix "how to edit Jekyll" docs so section-toc optional parameter displays in output --- solr/solr-ref-guide/src/meta-docs/jekyll.adoc | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/solr/solr-ref-guide/src/meta-docs/jekyll.adoc b/solr/solr-ref-guide/src/meta-docs/jekyll.adoc index f2a8b72a20e..264a5cddcd3 100644 --- a/solr/solr-ref-guide/src/meta-docs/jekyll.adoc +++ b/solr/solr-ref-guide/src/meta-docs/jekyll.adoc @@ -56,10 +56,17 @@ The Solr Ref Guide uses the front matter to define some custom attributes on a p There are also some optional custom attributes that can be defined in pages to affect the Table of Contents presentation in jekyll: * `page-toclevels` - changes how "deep" the TOC will be in terms of nested section/sub-section titles (default = 2) -* `page-tocclass` - changes the CSS class applied to the TOC, default = "normal", resulting in the class name `toc-normal`. The other option is "right", to put the TOC on the right side of the page. +* `page-tocclass` - changes the CSS class applied to the TOC. The default is `normal`, resulting in the class name `toc-normal` being used in the HTML. The other option is `right`, to put the TOC on the right side of the page. * `page-toc` - if this is false, then no TOCs will be generated for the page at all. -NOTE: The special macro `{section-toc}` can be used anywhere in a page to create an "In this Section" TOC covering only the sub-headings in the same section. `:page-toc: false` will also prevent this macro from working, so if you want no "top level" TOC, but you do want section TOCs, use `:page-toclevels: 0` +[NOTE] +==== +The special macro `\{section-toc}` can be used anywhere in a page to create an "In this Section" TOC covering only the sub-headings in the same section. + +Setting `:page-toc: false` will prevent this macro from working, so if you want no "top level" TOC, but you do want section TOCs, use `:page-toclevels: 0`. +==== + +The format for adding any parameter to the front matter is to use colons on both sides of the parameter, followed by the value for the parameter (such as `:page-toc: false`). === Layouts