Plugin: Github Alerts

Plugins
1

Github Alerts

Joplin GitHub npm

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.

image
image1141×771 37.2 KB

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

13 Likes
2

Cool! Thanks for making this.

3

Thank you for making this happen, it's really amazing.

4

Awesome. Many thanks. :slight_smile:

5

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?

1 Like