Note:
This plugin was created entirely with AI tools
Markdown Alerts
A Joplin plugin that adds support for Github alert syntax in the Markdown Editor and Markdown viewer.
Note:
Note that the Rich Text Editor is not supported. Alerts will (sort of) render in the Rich Text Editor, but editing the note in the Rich Text Editor will remove any github alert syntax.
Differences from "Github Alerts" plugin
The rendering of alerts in the markdown viewer is (almost) identical using markdown-it-github-alerts, but this plugin also styles the alerts inside the markdown editor and provides commands to quickly create/toggle alerts and block quotes.
Alert syntax
Alerts, also sometimes known as callouts or admonitions, are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information: Github Alerts Documentation
To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Five types of alerts are available:
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
> [!NOTE] Alert with a custom title
> This alert uses a custom title
Markdown Editor
Insert or Toggle alert
A command to quickly create an alert (or toggle alert types) is provided via an icon on the editing toolbar, keyboard shortcut (Ctrl + Shift + A by default), and an entry in the Edit menu. This command will either:
- On an empty line, insert a new alert (
> [!NOTE]) and place the cursor after the marker. - If the cursor is within an existing alert, toggle through the alert types (Note > Tip > Important > Warning > Caution).
- If the cursor is inside a regular blockquote, insert an alert title line above it (respecting nesting).
- If you have a selection, convert the selected paragraphs/lines into an alert (and toggle types if already an alert).
Insert or Toggle blockquote
A command to quickly insert or toggle blockquotes is provided via an icon on the editing toolbar, keyboard shortcut (Ctrl + Shift + . by default), and an entry in the Edit Menu. This command will either:
- On an empty line, insert
>and place the cursor after the marker. - With no selection, toggle the current paragraph (or line if no paragraph).
- With a selection, convert all paragraphs/lines in the selection to blockquotes (paragraph-aware).
The plugin will apply styling to block quotes containing github alert syntax. They will be similar to standard Joplin block quote styling, but with coloring based on the alert type, and the line with the alert syntax will be rendered as a title.
Markdown Viewer
Block quotes containing github alert syntax will be rendered as github style alerts in the markdown viewer using markdown-it-github-alerts.
