Skip to content

Commit

Permalink
feat: add doc on how to use admonitions
Browse files Browse the repository at this point in the history
  • Loading branch information
dimitri-fert committed May 20, 2024
1 parent 0dbc880 commit 3b1778e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,16 @@ If you need to add internal anchor links from your article to other article of o

> Warning: Don't add html in your markdown, you don't have to override the blog template in the markdown.
This blog supports admonitions pannels `warning` ; `info` ; `tip` and `note` to generate colored panels.
When using `<div>` attribute `markdown="1"` text block is rendered as Markdown. The first line must be left empty, else the block will be rendered as html

```md
<div class="admonition warning" markdown="1"><p class="admonition-title">Your Panel Title</p>

Your panel text.
</div>
```

**5 - Add your pull request**

Create your branch and add your pull request.
Expand Down

0 comments on commit 3b1778e

Please sign in to comment.