]> source.dussan.org Git - sonarqube.git/commitdiff
missing linebreak. minor content shuffle
authorG. Ann Campbell <ann.campbell@sonarsource.com>
Thu, 26 Jul 2018 20:39:47 +0000 (16:39 -0400)
committerSonarTech <sonartech@sonarsource.com>
Fri, 27 Jul 2018 18:21:19 +0000 (20:21 +0200)
server/sonar-docs/README.md

index 0957bc2dc72d8772a3ee961bd32cc7b6edeec81c..38ba0ba17e0fea5baac66d9c8af092c47cce1f78 100644 (file)
@@ -57,6 +57,7 @@ Each documentation file should contain a header at the top of the file delimited
   * “sonarqube” - visible only for SonarQube and the static website
   * “sonarcloud” - visible only for SonarCloud
   * "static" - visible only on the static website
+
 Ex.:
 ```
 ---
@@ -71,8 +72,6 @@ Basic syntax: `@include tooltips/quality-gates/quality-gate`
 * path omits trailing '.md'
 * path starts from 'src', regardless of where the including page is.
 
-
-
 ### Conditional Content
 
 With special comments you can mark a page or a part of the content to be displayed only on SonarCloud, SonarQube or the static documentation website.
@@ -107,12 +106,12 @@ You can also use inline comments:
 this content is displayed on <!-- sonarcloud -->SonarCloud<!-- /sonarcloud --><!-- sonarqube -->SonarQube<!-- /sonarqube -->
 ```
 
-
-### Formatting
-#### Page-level ToC
+### Page-level ToC
 Basic syntax: `## Table of Contents`
 Lists all h2 & h3 
 
+
+### Formatting
 #### Links
 * External page (automatically open in a new tab): `[Link text](https://www.sonarsource.com/)`
 * Another documentation page: `[Link text](/short-lived-branches)`
@@ -157,7 +156,7 @@ Basic syntax:
 | ## Block title
 | Block content
 ```
-The first line of the block must be a title. You can have as many line as you want after that.
+The first line of the block must be a title. You can have as many lines as you want after that.
 
 #### Images
 Basic syntax: `![alt text.](/images/short-lived-branch-concept.png)`