Github Alerts
GitHub Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information.
They are displayed with distinctive GitHub colors and icons to indicate the significance of the content.
Usage
Markdown example:
> [!NOTE]
> Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
Customization
Alternative titles are supported by appending them to the marker like this:
> [!note] Nota bene
> The custom title will replace the regular title.
Installation
Available via official plugin catalog: com.github.alan-null.joplin-plugin-github-alerts
Inspired by: GitHub Alerts
15 Likes
Cool! Thanks for making this.
Thank you for making this happen, it's really amazing.
Thank you again @alan-null for this plugin!
@laurent since, as I understand it, it is "just" an import of the npm package markdown-it-github-alerts - npm, and considering it's a beneficial feature and its growing popularity following GitHub's inclusion; would you agree we could incorporate this directly into Joplin's main code?
2 Likes
FYI, you may want to add a warning on the plugin page that making any edits to a note containing an alert in the Rich Text Editor will completely remove all formatting
e.g:
> [!note]
> test note
will turn into
note
test note
Thank you for reporting this.
It is indeed an annoying issue.
I noticed you had already opened an issue on GitHub (Dark Theme Issue · Issue #3 · alan-null/joplin-plugin-github-alerts), but the author seems to have other priorities at the moment.
This would be another good reason to integrate this functionality in the main Joplin code, as it will be easier to maintain.
It is worth noticing that Joplin already includes several “non-strict” Markdown extensions (see Markdown Guide | Joplin).
I hope someone will be able to implement this soon.
