diff options
| author | G. Ann Campbell <ann.campbell@sonarsource.com> | 2018-07-26 16:39:47 -0400 |
|---|---|---|
| committer | SonarTech <sonartech@sonarsource.com> | 2018-07-27 20:21:19 +0200 |
| commit | 163a351241801d54e3c24b9ff145c8eedf455320 (patch) | |
| tree | 1d46e2140a42baec3b85055e8df5b34b354f64d7 | |
| parent | ab3034f77c7f523ed76bf560f717394e2ea06f8d (diff) | |
| download | sonarqube-163a351241801d54e3c24b9ff145c8eedf455320.tar.gz sonarqube-163a351241801d54e3c24b9ff145c8eedf455320.zip | |
missing linebreak. minor content shuffle
| -rw-r--r-- | server/sonar-docs/README.md | 11 |
1 files 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 <!-- 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: `` |