]> source.dussan.org Git - sonarqube.git/commitdiff
update ToC section
authorG. Ann Campbell <ann.campbell@sonarsource.com>
Wed, 5 Sep 2018 15:41:36 +0000 (11:41 -0400)
committerSonarTech <sonartech@sonarsource.com>
Wed, 5 Sep 2018 18:21:03 +0000 (20:21 +0200)
[skip ci]

server/sonar-docs/README.md

index 839882127ce1f60ef8e4643bea707e81d1b3bcc3..05af399cff841be7d8b4c4b4b7bc3026a6616f9c 100644 (file)
@@ -140,6 +140,8 @@ Basic syntax: `## Table of Contents`
 Lists all h2 & h3  
 The resulting table of contents will also list all h1 items, but h1 is used for the page title, and by convention should not also be used further down the page.
 
+This conditional (i.e. only if you use the tag) ToC will _only_ appear in embedded docs. The static docs site will automatically list _all_ h2s in a page-level ToC added to the navigation rail (left-hand side of the page)
+
 ### Formatting
 
 #### Links