markdown-it-container

v4.0.0

Plugin to create block-level custom containers for markdown-it markdown parser For more information about how to use this package see README

Latest version published 1 year ago

License: MIT

NPM

GitHub

Package Health Score

59 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.0.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	06/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.0.0	\|	10/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	03/2015		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (239,683)

GitHub Stars: 503
Forks: 74
Contributors: 2

Direct Usage Popularity

The npm package markdown-it-container receives a total of 239,683 downloads a week. As such, we scored markdown-it-container popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package markdown-it-container, we found that it has been starred 503 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like markdown-it-container is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 0
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of markdown-it-container based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for markdown-it-container is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 10 years
Dependencies: 0 Direct
Versions: 5
Install Size: 20.1 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: Yes

markdown-it-container has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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:

<div class="warning">
<em>here be dragons</em>
</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:

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

API

var md = require('markdown-it')()
            .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

var md = require('markdown-it')();

md.use(require('markdown-it-container'), 'spoiler', {

  validate: function(params) {
    return params.trim().match(/^spoiler\s+(.*)$/);
  },

  render: function (tokens, idx) {
    var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/);

    if (tokens[idx].nesting === 1) {
      // opening tag
      return '<details><summary>' + md.utils.escapeHtml(m[1]) + '</summary>\n';

    } else {
      // closing tag
      return '</details>\n';
    }
  }
});

console.log(md.render('::: spoiler click me\n*content*\n:::\n'));

// Output:
//
// <details><summary>click me</summary>
// <p><em>content</em></p>
// </details>

License

MIT

markdown-it-container development dependencies

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

FAQs

What is markdown-it-container?

Plugin to create block-level custom containers for markdown-it markdown parser. Visit Snyk Advisor to see a full health score report for markdown-it-container, including popularity, security, maintenance & community analysis.

Is markdown-it-container popular?

The npm package markdown-it-container receives a total of 239,683 weekly downloads. As such, markdown-it-container popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is markdown-it-container well maintained?

We found indications that markdown-it-container is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is markdown-it-container safe to use?

The npm package markdown-it-container was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 06:22 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (239,683)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

markdown-it-container

Installation

API

Example

License

markdown-it-container development dependencies

FAQs

What is markdown-it-container?

Is markdown-it-container popular?

Is markdown-it-container well maintained?

Is markdown-it-container safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues