From: Wouter Admiraal Date: Wed, 8 May 2019 08:07:25 +0000 (+0200) Subject: SONAR-11954 Document how to use iframes in documentation, update styles X-Git-Tag: 7.8~149 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=7456816f75260ca484ef6b0474e01a4a6de27621;p=sonarqube.git SONAR-11954 Document how to use iframes in documentation, update styles --- diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md index 53fd054b4b6..5d98d7ecc7e 100644 --- a/server/sonar-docs/README.md +++ b/server/sonar-docs/README.md @@ -272,3 +272,45 @@ You can also put icons inside messages: [[danger]] | ![](/images/cross.svg) This is a **danger** message. ``` + +#### Iframes + +_Note: at this time, iframes are only supported for the static documentation, and will be stripped from the embedded documentation._ + +You can add iframes directly in the source: + +```html + + +``` + +Make sure to leave an empty line _after_ the closing tag, otherwise formatting of the following line could be incorrect: + +_Incorrect:_ +```md + +*Lorem ipsum* dolor sit amet. +``` + +_Correct:_ +```md + + +*Lorem ipsum* dolor sit amet. +``` + +By default, an iframe will have a height of 150px (as per browser specs). You can override this by adding a `height` attribute: + +```html + + +``` + +You cannot change the width, which is always 100%. + +Note that an iframe is **not** a self-closing tag. This means that the following syntax _won't work_ and will break the page in unexpected ways: + +```html +