jekyll-github-alerts

A Jekyll plugin to render GitHub style markdown alerts.

[!IMPORTANT] This plugin is meant to be used by jekyll-v4-theme-primer. It will still work without it, but the styling won't be correct.

Usage

1. Add this to your Gemfile

   gem 'jekyll-github-alerts'
   

2. Add this to your jekyll _config.yml

   plugins:
     - jekyll-github-alerts
   

3. Use the same syntax in your markdown as you would on GitHub

   > [!NOTE]
   > Useful information that users should know, even when skimming content.
   
   

Supported Alert Styles

[!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.

For more information on GitHub style alerts check out GitHub's docs.