Skip to content

Commit

Permalink
Add GitHub-style alerts to README
Browse files Browse the repository at this point in the history
  • Loading branch information
thomas-bc authored Nov 5, 2024
1 parent 206d78c commit 3bbebd5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,21 @@ massa, nec semper lorem quam in massa.
</td></tr>
</table>

### Support GitHub "alerts" style of admonitions

To enable, add to mkdocs.yml:
```
markdown_extensions:
- github-callouts
```
This can be used instead of, or in addition to, the other callouts extension shipped by this package. This adds support for [GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts).

The syntax is:
```
> [!NOTE]
> Lorem ipsum dolor sit amet.
```

---

**Continue to the [documentation site][].**

0 comments on commit 3bbebd5

Please sign in to comment.