---
description: Enable GitHub-flavored Markdown features in Wenmode with the github preset and GitHub alert blockquotes with the github_alert plugin.
---
(recipes-github-flavored-markdown)=
# GitHub-flavored Markdown
```{rst-class} lead
Enable GitHub-flavored Markdown features with the `github` preset, then add
GitHub alert blockquotes when your product needs them.
```
---
## Use the GitHub preset
Use the `github` preset when you want tables, task list items, strikethrough,
bare URL autolinks, footnotes, and GFM disallowed HTML handling.
```python
from wenmode import Wenmode
from wenmode.presets import github
wen = Wenmode(github)
text = '''
- [x] done
| A | B |
| --- | --- |
| **x** | https://example.com |
'''
html = wen.render(text)
assert '' in html
assert '
' in html
assert 'https://example.com' in html
```
For exact preset membership, see {ref}`presets` and {ref}`rule-matrix`.
## Add GitHub alerts
GitHub alert blockquotes are provided by the `github_alert` plugin. Use it with
the `github` preset when your Markdown should support alert blocks such as
`[!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`, and `[!CAUTION]`.
```python
from wenmode import Wenmode
from wenmode.plugins import github_alert
from wenmode.presets import github
wen = Wenmode(github, plugins=[github_alert])
text = '''
> [!NOTE]
> **Read** this before deploying.
'''
html = wen.render(text)
assert '
' in html
assert '
Note
' in html
assert 'Read' in html
```
When you want Wenmode's admonition HTML classes instead of GitHub's
`markdown-alert` classes, configure the plugin:
```python
from wenmode import Wenmode
from wenmode.plugins import github_alert
from wenmode.presets import github
wen = Wenmode(github, plugins=[github_alert.configure(html_style='admonition')])
text = '''
> [!WARNING]
> Check the migration notes.
'''
html = wen.render(text)
assert '