{"_id":"markdown-it-container","_rev":"402119","name":"markdown-it-container","description":"Plugin to create block-level custom containers for markdown-it markdown parser","dist-tags":{"latest":"3.0.0"},"maintainers":[{"name":"vitaly","email":"vitaly@rcdesign.ru"}],"time":{"modified":"2021-08-04T04:34:30.000Z","created":"2015-03-13T07:39:10.513Z","3.0.0":"2020-06-02T13:46:09.047Z","2.0.0":"2015-10-05T11:24:11.036Z","1.0.0":"2015-03-13T07:39:10.513Z"},"users":{"xiechao06":true,"codevinsky":true,"dwqs":true,"monjer":true},"repository":{"type":"git","url":"git+https://github.com/markdown-it/markdown-it-container.git"},"versions":{"3.0.0":{"name":"markdown-it-container","version":"3.0.0","description":"Plugin to create block-level custom containers for markdown-it markdown parser","repository":{"type":"git","url":"git+https://github.com/markdown-it/markdown-it-container.git"},"license":"MIT","scripts":{"lint":"eslint .","test":"npm run lint && nyc mocha","coverage":"npm run test && nyc report --reporter html","report-coveralls":"nyc report --reporter=text-lcov | coveralls"},"keywords":["markdown-it-plugin","markdown-it","markdown"],"devDependencies":{"browserify":"^16.5.1","coveralls":"^3.1.0","eslint":"^7.1.0","markdown-it":"github:markdown-it/markdown-it","markdown-it-testgen":"~0.1.0","mocha":"^7.2.0","nyc":"^15.1.0","terser":"^4.7.0"},"gitHead":"adb3defde3a1c56015895b47ce4c6591b8b1e3a2","bugs":{"url":"https://github.com/markdown-it/markdown-it-container/issues"},"homepage":"https://github.com/markdown-it/markdown-it-container#readme","_id":"markdown-it-container@3.0.0","_nodeVersion":"12.14.1","_npmVersion":"6.13.4","dist":{"shasum":"1d19b06040a020f9a827577bb7dbf67aa5de9a5b","size":5200,"noattachment":false,"key":"/markdown-it-container/-/markdown-it-container-3.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/markdown-it-container/download/markdown-it-container-3.0.0.tgz"},"maintainers":[{"name":"vitaly","email":"vitaly@rcdesign.ru"}],"_npmUser":{"name":"vitaly","email":"vitaly@rcdesign.ru"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-it-container_3.0.0_1591105568941_0.02557169039787599"},"_hasShrinkwrap":false,"publish_time":1591105569047,"_cnpm_publish_time":1591105569047},"2.0.0":{"name":"markdown-it-container","version":"2.0.0","description":"Plugin to create block-level custom containers for markdown-it markdown parser","repository":{"type":"git","url":"git+https://github.com/markdown-it/markdown-it-container.git"},"license":"MIT","scripts":{"test":"make test"},"keywords":["markdown-it-plugin","markdown-it","markdown"],"devDependencies":{"browserify":"*","coveralls":"^2.11.2","eslint":"0.13.0","eslint-plugin-nodeca":"^1.0.0","istanbul":"*","markdown-it":"github:markdown-it/markdown-it","markdown-it-testgen":"~0.1.0","mocha":"*","uglify-js":"*"},"gitHead":"ae8b3424abf000d064bdccc3457efdebb85718b6","bugs":{"url":"https://github.com/markdown-it/markdown-it-container/issues"},"homepage":"https://github.com/markdown-it/markdown-it-container#readme","_id":"markdown-it-container@2.0.0","_shasum":"0019b43fd02eefece2f1960a2895fba81a404695","_from":".","_npmVersion":"2.10.1","_nodeVersion":"0.12.4","_npmUser":{"name":"vitaly","email":"vitaly@rcdesign.ru"},"maintainers":[{"name":"vitaly","email":"vitaly@rcdesign.ru"}],"dist":{"shasum":"0019b43fd02eefece2f1960a2895fba81a404695","size":5023,"noattachment":false,"key":"/markdown-it-container/-/markdown-it-container-2.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/markdown-it-container/download/markdown-it-container-2.0.0.tgz"},"directories":{},"publish_time":1444044251036,"_cnpm_publish_time":1444044251036,"_hasShrinkwrap":false},"1.0.0":{"name":"markdown-it-container","version":"1.0.0","description":"Plugin to create block-level custom containers for markdown-it markdown parser","repository":{"type":"git","url":"https://github.com/markdown-it/markdown-it-container"},"license":"MIT","scripts":{"test":"make test"},"keywords":["markdown-it-plugin","markdown-it","markdown"],"devDependencies":{"browserify":"*","coveralls":"^2.11.2","eslint":"0.13.0","eslint-plugin-nodeca":"^1.0.0","istanbul":"*","markdown-it":"^4.0.0","markdown-it-testgen":"~0.1.0","mocha":"*","uglify-js":"*"},"gitHead":"4db3c43ad06eb39129932ded825a3652c0ea76b6","bugs":{"url":"https://github.com/markdown-it/markdown-it-container/issues"},"homepage":"https://github.com/markdown-it/markdown-it-container","_id":"markdown-it-container@1.0.0","_shasum":"d2e8269d467c056c6c9ef6b7b16f129a19b9f36d","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"vitaly","email":"vitaly@rcdesign.ru"},"maintainers":[{"name":"vitaly","email":"vitaly@rcdesign.ru"}],"dist":{"shasum":"d2e8269d467c056c6c9ef6b7b16f129a19b9f36d","size":4940,"noattachment":false,"key":"/markdown-it-container/-/markdown-it-container-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/markdown-it-container/download/markdown-it-container-1.0.0.tgz"},"directories":{},"publish_time":1426232350513,"_cnpm_publish_time":1426232350513,"_hasShrinkwrap":false}},"readme":"# markdown-it-container\n\n[![Build Status](https://img.shields.io/travis/markdown-it/markdown-it-container/master.svg?style=flat)](https://travis-ci.org/markdown-it/markdown-it-container)\n[![NPM version](https://img.shields.io/npm/v/markdown-it-container.svg?style=flat)](https://www.npmjs.org/package/markdown-it-container)\n[![Coverage Status](https://img.shields.io/coveralls/markdown-it/markdown-it-container/master.svg?style=flat)](https://coveralls.io/r/markdown-it/markdown-it-container?branch=master)\n\n> Plugin for creating block-level custom containers for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser.\n\n__v2.+ requires `markdown-it` v5.+, see changelog.__\n\nWith this plugin you can create block containers like:\n\n```\n::: warning\n*here be dragons*\n:::\n```\n\n.... and specify how they should be rendered. If no renderer defined, `<div>` with\ncontainer name class will be created:\n\n```html\n<div class=\"warning\">\n<em>here be dragons</em>\n</div>\n```\n\nMarkup is the same as for [fenced code blocks](http://spec.commonmark.org/0.18/#fenced-code-blocks).\nDifference is, that marker use another character and content is rendered as markdown markup.\n\n\n## Installation\n\nnode.js, browser:\n\n```bash\n$ npm install markdown-it-container --save\n$ bower install markdown-it-container --save\n```\n\n\n## API\n\n```js\nvar md = require('markdown-it')()\n            .use(require('markdown-it-container'), name [, options]);\n```\n\nParams:\n\n- __name__ - container name (mandatory)\n- __options:__\n   - __validate__ - optional, function to validate tail after opening marker, should\n     return `true` on success.\n   - __render__ - optional, renderer function for opening/closing tokens.\n   - __marker__ - optional (`:`), character to use in delimiter.\n\n\n## Example\n\n```js\nvar md = require('markdown-it')();\n\nmd.use(require('markdown-it-container'), 'spoiler', {\n\n  validate: function(params) {\n    return params.trim().match(/^spoiler\\s+(.*)$/);\n  },\n\n  render: function (tokens, idx) {\n    var m = tokens[idx].info.trim().match(/^spoiler\\s+(.*)$/);\n\n    if (tokens[idx].nesting === 1) {\n      // opening tag\n      return '<details><summary>' + md.utils.escapeHtml(m[1]) + '</summary>\\n';\n\n    } else {\n      // closing tag\n      return '</details>\\n';\n    }\n  }\n});\n\nconsole.log(md.render('::: spoiler click me\\n*content*\\n:::\\n'));\n\n// Output:\n//\n// <details><summary>click me</summary>\n// <p><em>content</em></p>\n// </details>\n```\n\n## License\n\n[MIT](https://github.com/markdown-it/markdown-it-container/blob/master/LICENSE)\n","_attachments":{},"homepage":"https://github.com/markdown-it/markdown-it-container#readme","bugs":{"url":"https://github.com/markdown-it/markdown-it-container/issues"},"license":"MIT"}