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

markdown-it-admonition

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

markdown-it-admonition

Markdown-it admonition plugin

  • 1.0.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
149
decreased by-64.86%
Maintainers
1
Weekly downloads
 
Created
Source

Admonition plug-in

A simple admonition plugin for markdown-it

Usage

To use this plugin, simply:

npm install markdown-it-adminition --save
    var markdown = require("markdown-it")({html: true})        
        .use(require("markdown-it-adminition"));
!!! note This is the admonition title
This is the admonition body
!!!

This will output the following HTML

<div class="admonition note">
<p class="admonition-title">This is the admonition title</p>
<p>This is the admonition body</p>
</div>

The following adminition types, supported by Docarys, are recognized by this plugin:

Type
note
abstract
info
tip
success
question
warning
failure
danger
bug
example
quote"

You can customize the types you want to use by passing it as opts.

if no title is specified, admonition type will be used as default title.

Keywords

FAQs

Package last updated on 07 Jul 2018

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