Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

jekyll-github-alerts

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jekyll-github-alerts

  • 0.1.0
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

jekyll-github-alerts

Gem Version

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.

FAQs

Package last updated on 21 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc