diff options
| author | Grégoire Aubert <gregoire.aubert@sonarsource.com> | 2019-04-12 09:23:21 +0200 |
|---|---|---|
| committer | SonarTech <sonartech@sonarsource.com> | 2019-04-12 20:21:04 +0200 |
| commit | de4e00128416b169fa1cd687ba9e8391eada3b30 (patch) | |
| tree | edccd79917ccb1c2c92b02fc7054664caeef5a6c /server/sonar-docs/README.md | |
| parent | a8ef73530b86fc2929875a45234a746a76047545 (diff) | |
| download | sonarqube-de4e00128416b169fa1cd687ba9e8391eada3b30.tar.gz sonarqube-de4e00128416b169fa1cd687ba9e8391eada3b30.zip | |
SONAR-11956 Remove TOC related code in static doc
Diffstat (limited to 'server/sonar-docs/README.md')
| -rw-r--r-- | server/sonar-docs/README.md | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md index 95618ec0552..53fd054b4b6 100644 --- a/server/sonar-docs/README.md +++ b/server/sonar-docs/README.md @@ -167,12 +167,9 @@ this content is displayed on <!-- sonarcloud -->SonarCloud<!-- /sonarcloud --><! ### Page-level ToC -Basic syntax: `## Table of Contents` -Lists all h2 & h3 +All h2 tags will automatically be part of the TOC both in the static and embed documentation. 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 |