Skip to content

Commit

Permalink
issue #235 - update site documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bsorrentino committed Dec 11, 2020
1 parent d4f9253 commit 67c687b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 30 deletions.
63 changes: 36 additions & 27 deletions plugin-reporting/src/site/markdown/markdown_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ To use markdown it is enough to specify a **.md** file in the **site's uri**.

Below the supported format:


### Header
```
# h1
Expand Down Expand Up @@ -142,7 +141,7 @@ Colons can be used to align columns.
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
Markdown | Less | Pretty
Expand All @@ -169,54 +168,64 @@ Markdown | Less | Pretty

]]></pre>

### Confluence specific

#### Notice Block Syntax

### Notice Block Syntax (Confluence specific)
The **Notice Block Syntax** are particular confluence panel used to give a meaningful notice. The image below show an example of the currently supported block

### Info
<img src="images/noticeblock.png"/>

##### Info

<pre><![CDATA[
> **info:** About me
> **info:** title
>
>> tposidufsqdf qsfpqs dfopqsdijf q
>> mldjkflqsdif sqj
> Body Text
>

]]></pre>

### Note without title
##### Tip

<pre><![CDATA[
> **Note:**
> **tip:** Title
>
> Contents of my note
> Body Text
>

]]></pre>

### Tip
##### Warning

<pre><![CDATA[
> **tip:** About you
> **warning:** Title
>
> tposidufsqdf qsfpqs dfopqsdijf q
> mldjkflqsdif sqj
> Body Text
>

]]></pre>


### Warning with complex content
##### Note

<pre><![CDATA[
> **warning:** About him
>
> tposidufsqdf qsfpqs dfopqsdijf q
> mldjkflqsdif sqj
> **Note:** title
>
> - one
> - two
> Body Text
>
> have a **strong** and _pure_ feeling

]]></pre>

### Include custom macro(s)

to add a confluence macro consistently with markdown format, you have to wrap it within an **HTML comment**. Below some examples:

```
<!-- {toc:minLevel=2} -->
# This is table of content
* Menu
* Menu item1
* Menu item2
* Related pages
<!--
{children:depth=1}
-->
```
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions processor-commonmark/src/test/resources/macro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
{toc}
<!--
{toc}
-->
# This is table of content

Expand All @@ -13,4 +13,4 @@
* Related pages
<!--
{children:depth=1}
-->
-->

0 comments on commit 67c687b

Please sign in to comment.