From 163a351241801d54e3c24b9ff145c8eedf455320 Mon Sep 17 00:00:00 2001 From: "G. Ann Campbell" Date: Thu, 26 Jul 2018 16:39:47 -0400 Subject: [PATCH] missing linebreak. minor content shuffle --- server/sonar-docs/README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md index 0957bc2dc72..38ba0ba17e0 100644 --- a/server/sonar-docs/README.md +++ b/server/sonar-docs/README.md @@ -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 SonarCloudSonarQube ``` - -### 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)` -- 2.39.5