npmpackage.info

Gathering detailed insights and metrics for markdown-it-container

Other packages similar to markdown-it-container

@types/markdown-it-container

2.0.10

TypeScript definitions for markdown-it-container

@mdit/plugin-container

0.22.1

container plugin for MarkdownIt

markdown-it-front-matter

0.2.4

Plugin to process front matter container for markdown-it markdown parser

remark-container

0.1.2

markdown container like [markdown-it-container](https://github.com/markdown-it/markdown-it-container)

Gathering detailed insights and metrics for markdown-it-container

markdown-it-container - 4.0.0 | npmpackage.info

markdown-it-container

Fenced container plugin for markdown-it markdown parser

4.0.0

542

MIT

JavaScript

19.60 kB

4.1

Installations

npm install markdown-it-container

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Node Version

18.14.1

NPM Version

9.3.1 Pull Requests

Open

0

Total

6

Closed

5

Merged

1

Issues

Open

2

Total

46

Closed

44

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

markdown-it

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

542 Stars

25 Commits

76 Forks

7 Watchers

1 Branches

3 Contributors

Updated on Jul 08, 2025

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

4.0.0

Package Id

markdown-it-container@4.0.0

Unpacked Size

19.60 kB

Size

5.21 kB

File Count

NPM Version

9.3.1

Node Version

18.14.1

Published on

Dec 05, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@rollup/plugin-babel @rollup/plugin-node-resolve @rollup/plugin-terser c8 eslint eslint-config-standard markdown-it markdown-it-testgen mocha rollup

markdown-it-container

Plugin for creating block-level custom containers for markdown-it markdown parser.

v2.+ requires markdown-it v5.+, see changelog.

With this plugin you can create block containers like:

::: warning
*here be dragons*
:::

.... and specify how they should be rendered. If no renderer defined, <div> with container name class will be created:

1<div class="warning">
2<em>here be dragons</em>
3</div>

Markup is the same as for fenced code blocks. Difference is, that marker use another character and content is rendered as markdown markup.

Installation

node.js, browser:

1$ npm install markdown-it-container --save
2$ bower install markdown-it-container --save

API

1var md = require('markdown-it')()
2            .use(require('markdown-it-container'), name [, options]);

Params:

name - container name (mandatory)
options:
- validate - optional, function to validate tail after opening marker, should return true on success.
- render - optional, renderer function for opening/closing tokens.
- marker - optional (:), character to use in delimiter.

Example

1var md = require('markdown-it')();
2
3md.use(require('markdown-it-container'), 'spoiler', {
4
5  validate: function(params) {
6    return params.trim().match(/^spoiler\s+(.*)$/);
7  },
8
9  render: function (tokens, idx) {
10    var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/);
11
12    if (tokens[idx].nesting === 1) {
13      // opening tag
14      return '<details><summary>' + md.utils.escapeHtml(m[1]) + '</summary>\n';
15
16    } else {
17      // closing tag
18      return '</details>\n';
19    }
20  }
21});
22
23console.log(md.render('::: spoiler click me\n*content*\n:::\n'));
24
25// Output:
26//
27// <details><summary>click me</summary>
28// <p><em>content</em></p>
29// </details>

License

MIT

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.1

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More