{ "name": "remarkable-admonitions", "versions": { "0.2.0": { "name": "remarkable-admonitions", "version": "0.2.0", "description": "A remarkable plugin to add admonitions support", "repository": { "type": "git", "url": "git+https://github.com/favoloso/remarkable-admonitions.git" }, "author": { "name": "Leonardo Ascione", "email": "leonardo@favoloso.team" }, "license": "MIT", "scripts": { "dev": "babel src -w -d lib -x '.ts,.tsx'", "build": "yarn build:lib && yarn build:types", "prebuild:lib": "rm -rf lib", "build:lib": "babel src -d lib -x '.ts,.tsx'", "build:types": "tsc --emitDeclarationOnly", "check-types": "tsc --noEmit", "release": "yarn test && yarn build && release-it", "test": "jest", "test:dev": "jest --watch", "test:ci": "jest --ci --runInBand --coverage --reporters=default --reporters=jest-junit" }, "main": "lib/index.js", "types": "lib/index.d.ts", "keywords": [ "remarkable-plugin", "docusaurus-plugin", "callout", "markdown" ], "husky": { "hooks": { "commit-msg": "emoji-commit-lint" } }, "release-it": { "git": { "tagName": "v${version}", "commitMessage": "🔖 v${version}" }, "github": { "release": true }, "increment": "conventional:@favoloso/emoji", "scripts": { "changelog": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji | tail -n +3", "beforeStage": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji -i CHANGELOG.md -s" } }, "publishConfig": { "registry": "https://registry.npmjs.org/" }, "devDependencies": { "@babel/cli": "^7.2.3", "@babel/core": "^7.3.4", "@babel/preset-env": "^7.3.4", "@babel/preset-typescript": "^7.3.3", "@favoloso/conventional-changelog-emoji": "^0.9.0", "@types/dedent": "^0.7.0", "@types/jest": "^24.0.11", "@types/remarkable": "^1.7.2", "babel-jest": "^24.3.1", "babel-plugin-add-module-exports": "^1.0.0", "conventional-changelog-cli": "^2.0.12", "dedent": "^0.7.0", "husky": "^1.3.1", "jest": "^24.3.1", "jest-junit": "^6.3.0", "prettier": "^1.16.4", "release-it": "^10.3.1", "remarkable": "^1.7.1", "typescript": "^3.3.3333" }, "gitHead": "b1ace4d9cf6304fcf367197771788fd6a346e376", "bugs": { "url": "https://github.com/favoloso/remarkable-admonitions/issues" }, "homepage": "https://github.com/favoloso/remarkable-admonitions#readme", "_id": "remarkable-admonitions@0.2.0", "_npmVersion": "6.4.1", "_nodeVersion": "10.14.1", "_npmUser": { "name": "leonardfactory", "email": "leonardo@favoloso.team" }, "dist": { "integrity": "sha512-iAFcrIOUDc8x0G8k30Xqc7adoHxo0vVv07Qg4dARmdjvkMGkyJQ/DAARUcEKX/+sY3tDiwxBPpFHm+v3xjf2VA==", "shasum": "d6aa536e00eb284217838d2470ec6d2dd74e70b4", "tarball": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.0.tgz", "fileCount": 31, "unpackedSize": 24763, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJciE04CRA9TVsSAnZWagAAQ+kP/2XgmaiajC3p+6+Sd1Dc\nvRKRAxJtM4nRzO36VYbxWJlaOg7HH2MfrlaF6ujZLgLEKhljhXWuPz3s/dLa\nfXl4N2KmVuHWRqACGiJavOB+LGM2hzC67CpU3cExvnes64KU05652FlvujRr\nsBjUFMAXEzzKvbY3yHw2oQtROeK6xTd3YxxucsKg2IKyLeFPStutNh3y8P2l\nqrtVoK3mgQ3Mlgztlxg8C+qWJ2idggR/mtYuJvOs9gvjwvIHIWo20+zIaCgV\nC7TBxDM2cUARSXlveKpZu91Pox93exJeWWDMVyE/Lx77mtfJRV1Xv3bfmfI6\nybbK3z+vkghW1SMG3EAOXwqga92vgjvDzV0PDkQ5oaT0pZks/AA6V1Npyhfw\nnz2A7xy2MiSdt1RsuM/0P9MFtgL2TcWbqWHYrbM/zhJosBf2l4cOxXFylivg\nnlaYiskBI/gNP/QpS/KwZzVM1WuAHa9mazYx0vPpsl205S1cCavIVkAvuOJm\nwPtiCoVa3FnoFpmBGRXgfEsAm9jNu2Zov0cTec+AqGv8l20R7Ki/wlM4enXe\nUSQ6jaZ7ju/fUuJejfwsPzUIYWKKda3zkWahek2GyqkoHeujFdxcmWgzZ/wO\nVJkpX/PoiUDzRqqiinGhV4m6hseuytJcxhmUmdcnENp841GhFmaKO7vwa38P\nPa4A\r\n=JOZz\r\n-----END PGP SIGNATURE-----\r\n" }, "maintainers": [ { "name": "leonardfactory", "email": "leonardo@favoloso.team" } ], "directories": {}, "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/remarkable-admonitions_0.2.0_1552436535478_0.05172293947875728" }, "_hasShrinkwrap": false, "contributors": [] }, "0.2.1": { "name": "remarkable-admonitions", "version": "0.2.1", "description": "A remarkable plugin to add admonitions support", "repository": { "type": "git", "url": "git+https://github.com/favoloso/remarkable-admonitions.git" }, "author": { "name": "Leonardo Ascione", "email": "leonardo@favoloso.team" }, "license": "MIT", "scripts": { "dev": "babel src -w -d lib -x '.ts,.tsx'", "build": "yarn build:lib && yarn build:types", "prebuild:lib": "rm -rf lib", "build:lib": "babel src -d lib -x '.ts,.tsx'", "build:types": "tsc --emitDeclarationOnly", "check-types": "tsc --noEmit", "release": "yarn test && yarn build && release-it", "test": "jest", "test:dev": "jest --watch", "test:ci": "jest --ci --runInBand --coverage --reporters=default --reporters=jest-junit" }, "main": "lib/index.js", "types": "lib/index.d.ts", "keywords": [ "remarkable-plugin", "docusaurus-plugin", "callout", "markdown" ], "husky": { "hooks": { "commit-msg": "emoji-commit-lint" } }, "release-it": { "git": { "tagName": "v${version}", "commitMessage": "🔖 v${version}" }, "github": { "release": true }, "increment": "conventional:@favoloso/emoji", "scripts": { "changelog": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji | tail -n +3", "beforeStage": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji -i CHANGELOG.md -s" } }, "publishConfig": { "registry": "https://registry.npmjs.org/" }, "devDependencies": { "@babel/cli": "^7.2.3", "@babel/core": "^7.3.4", "@babel/preset-env": "^7.3.4", "@babel/preset-typescript": "^7.3.3", "@favoloso/conventional-changelog-emoji": "^0.9.0", "@types/dedent": "^0.7.0", "@types/jest": "^24.0.11", "@types/remarkable": "^1.7.2", "babel-jest": "^24.3.1", "babel-plugin-add-module-exports": "^1.0.0", "conventional-changelog-cli": "^2.0.12", "dedent": "^0.7.0", "husky": "^1.3.1", "jest": "^24.3.1", "jest-junit": "^6.3.0", "prettier": "^1.16.4", "release-it": "^10.3.1", "remarkable": "^1.7.1", "typescript": "^3.3.3333" }, "gitHead": "a5c0c815b73cf72f1c9afd987f6c9fe87684833b", "bugs": { "url": "https://github.com/favoloso/remarkable-admonitions/issues" }, "homepage": "https://github.com/favoloso/remarkable-admonitions#readme", "_id": "remarkable-admonitions@0.2.1", "_npmVersion": "6.4.1", "_nodeVersion": "10.14.1", "_npmUser": { "name": "leonardfactory", "email": "leonardo@favoloso.team" }, "dist": { "integrity": "sha512-Uqeye087AIuo+BMUwteuG7e3GhoPqeT8aFjD8DaIqjUk2rn+7T7A6xank7fVlU+GHgbjT49DDC13nHLWwdBxRw==", "shasum": "425ceb34e01a1f169048d9687a5c8e16675da26c", "tarball": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.1.tgz", "fileCount": 31, "unpackedSize": 26409, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJciFGjCRA9TVsSAnZWagAAwagP/0wV+BQl8gzMv3xRUVuc\nsV9ddkLzenbst/YLwq2wnvCJH6Ne8DercsyGWUyp7TmSTfErvFQ1X6eoHxWd\n10cSajomRN1AS2l2NHLsLikTYzhvcMJaTXxtCHXdcWmIs5EhAm5Er0agP6aR\nVO8lPUnsXg8xy6yaPWnWwJUytTYa3J46s78/fmZPwAfupVYMWO+bZjWiskYv\nSAk4PoUyBkMcSdxwLE5LP8NWdsJmOji9HLYcHUt+9smPurKj/1bZ6UEcqybg\nDSQ9y8CM5VstlLyYCEq8s+PjLe+ywEpOXanF+CX+sJ27gEb6oxeM0tJ8Xf/6\n78mahytgw6qmT1JJnXh29vxccPbBeT3hKjQTCsueu4dNj6YfbVOVNwvJ1dSC\ngHClQRmjN0pBY6i0ljKlSuMD3/GJWgNA4OTT45vcMW9xC+SYjqa3saGaBct5\nvrrb9sUYR123QiqNnaLRBfFtizaHp7/RhbzljDJNeoNGthwHrjGpH9JzLm6S\nkLyIvUBUF1k12cLj5c33gye4GKLwEWwFPkk6X4J1bd2Q4VnAskeo3T7r3JPN\nqoffgB0wXWjP6rkBv/1KW7zoUHFr+xN90I6fEY0ijgHsHHnljPShivb1X2FR\nc5DxAN5fr+zU0cHHCyciwNkqnpN1vytLrDIoHTJy8Me1ZbYBJTNytOffWWHQ\nqKLn\r\n=Wfl4\r\n-----END PGP SIGNATURE-----\r\n" }, "maintainers": [ { "name": "leonardfactory", "email": "leonardo@favoloso.team" } ], "directories": {}, "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/remarkable-admonitions_0.2.1_1552437667035_0.21844059774327795" }, "_hasShrinkwrap": false, "contributors": [] }, "0.2.2": { "name": "remarkable-admonitions", "version": "0.2.2", "description": "A remarkable plugin to add admonitions support", "repository": { "type": "git", "url": "git+https://github.com/favoloso/remarkable-admonitions.git" }, "author": { "name": "Leonardo Ascione", "email": "leonardo@favoloso.team" }, "license": "MIT", "scripts": { "dev": "babel src -w -d lib -x '.ts,.tsx'", "build": "yarn build:lib && yarn build:types", "prebuild:lib": "rm -rf lib", "build:lib": "babel src -d lib -x '.ts,.tsx'", "build:types": "tsc --emitDeclarationOnly", "check-types": "tsc --noEmit", "release": "yarn test && yarn build && release-it", "test": "jest", "test:dev": "jest --watch", "test:ci": "jest --ci --runInBand --coverage --reporters=default --reporters=jest-junit" }, "main": "lib/index.js", "types": "lib/index.d.ts", "keywords": [ "remarkable-plugin", "docusaurus-plugin", "callout", "markdown" ], "husky": { "hooks": { "commit-msg": "emoji-commit-lint" } }, "release-it": { "git": { "tagName": "v${version}", "commitMessage": "🔖 v${version}" }, "github": { "release": true }, "increment": "conventional:@favoloso/emoji", "scripts": { "changelog": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji | tail -n +3", "beforeStage": "./node_modules/.bin/conventional-changelog -p @favoloso/emoji -i CHANGELOG.md -s" } }, "publishConfig": { "registry": "https://registry.npmjs.org/" }, "devDependencies": { "@babel/cli": "^7.2.3", "@babel/core": "^7.3.4", "@babel/preset-env": "^7.3.4", "@babel/preset-typescript": "^7.3.3", "@favoloso/conventional-changelog-emoji": "^0.9.0", "@types/dedent": "^0.7.0", "@types/jest": "^24.0.11", "@types/remarkable": "^1.7.2", "babel-jest": "^24.3.1", "babel-plugin-add-module-exports": "^1.0.0", "conventional-changelog-cli": "^2.0.12", "dedent": "^0.7.0", "husky": "^1.3.1", "jest": "^24.3.1", "jest-junit": "^6.3.0", "prettier": "^1.16.4", "release-it": "^10.3.1", "remarkable": "^1.7.1", "typescript": "^3.3.3333" }, "gitHead": "042d6e109eee77fb308a79935cc4f696880b0156", "bugs": { "url": "https://github.com/favoloso/remarkable-admonitions/issues" }, "homepage": "https://github.com/favoloso/remarkable-admonitions#readme", "_id": "remarkable-admonitions@0.2.2", "_nodeVersion": "8.11.1", "_npmVersion": "6.7.0", "dist": { "integrity": "sha512-CcMTEcLYmJLXX3IVMk4LyW4oFD2NQxh5FeLzn4k89TAPpyWIeVix/B/g/gDbZAUpCNY9l6heovR5NNIktf8X5A==", "shasum": "8765f9ec66be4f4c651a4e1cfb559dd7f920819c", "tarball": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.2.tgz", "fileCount": 31, "unpackedSize": 27692, "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeHfh3CRA9TVsSAnZWagAAHM8P/0JVBbVlNcsnwsjUtt50\nZn8njssN6ANWY3HEqB1k8jWqbd1DESDmo9Vkh6ChX6UiXryLnFaTVRkkxVyB\nz7X+iCcTfxcI8RbJsleh/puHHZEowNLt5V1GqfBrCeHM2S9CbveJmH8ZHy/Z\n9LpmlDzsQ0Ocsxs8TN0Rhj2TbjYyIOHzTfVX2FBL5KdAQc2dHsmJI+Z87jd1\nr9EZkmchMPaWqAxULk9xoreVtKto3QOvMj/JUIif8nhOAxwwjY+ey72HNuEv\nbnB0veNSrTW7w1Bq/TuM2fLTR8pvP6ufbLpPCxk+/zSvbkqiENl6GtX7p9mz\nUonqTzgKEW9sclgM8WCcc32rIdy8pjaHMu7bEcYlDtfkw97LsKFsPjXRUc/C\nNsYoAXmFsbOCrZjiE5FkPzLrwFMRQE1L8LH5BTXFxGNmx6J08P3AHmaPIiID\nXCrGhl0kXcDUH/2pzxkulTq/16RJvWVVB8mHnu2Jud4/HxpwcwAOigJzgvT4\npe0aBSPzixwyOSMdHcxYaz9pvinNS93aMxaCjPZPvT+IBGwppsMP8ZhD0HWS\n7BIKvcTbVVirTTzzzQtalWi7fdTcDDauNQzsI7dzX8c0OkRgjtX0J4oma7+Z\nYHmQsIzWrK4iJR3BzFeebpc3EacWKica1ztrgoJ0LvlF/Sfzy2B+AiRri4oZ\nHw9C\r\n=GH36\r\n-----END PGP SIGNATURE-----\r\n" }, "maintainers": [ { "name": "leonardfactory", "email": "leonardo@favoloso.team" } ], "_npmUser": { "name": "leonardfactory", "email": "leonardo@favoloso.team" }, "directories": {}, "_npmOperationalInternal": { "host": "s3://npm-registry-packages", "tmp": "tmp/remarkable-admonitions_0.2.2_1579022454611_0.20483971264317602" }, "_hasShrinkwrap": false, "contributors": [] } }, "time": { "created": "2019-03-13T00:22:15.476Z", "0.2.0": "2019-03-13T00:22:15.638Z", "modified": "2020-01-14T17:20:57.347Z", "0.2.1": "2019-03-13T00:41:07.191Z", "0.2.2": "2020-01-14T17:20:54.775Z" }, "users": {}, "dist-tags": { "latest": "0.2.2" }, "_uplinks": { "npmjs": { "etag": "W/\"97e9c614d4f23cf04fde3052aec580fe\"", "fetched": 1600679284314 } }, "_distfiles": { "remarkable-admonitions-0.2.0.tgz": { "url": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.0.tgz", "sha": "d6aa536e00eb284217838d2470ec6d2dd74e70b4", "registry": "npmjs" }, "remarkable-admonitions-0.2.1.tgz": { "url": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.1.tgz", "sha": "425ceb34e01a1f169048d9687a5c8e16675da26c", "registry": "npmjs" }, "remarkable-admonitions-0.2.2.tgz": { "url": "https://registry.npmjs.org/remarkable-admonitions/-/remarkable-admonitions-0.2.2.tgz", "sha": "8765f9ec66be4f4c651a4e1cfb559dd7f920819c", "registry": "npmjs" } }, "_attachments": { "remarkable-admonitions-0.2.1.tgz": { "shasum": "425ceb34e01a1f169048d9687a5c8e16675da26c" } }, "_rev": "2-4097d7e213f1874a", "_id": "remarkable-admonitions", "readme": "# remarkable-admonitions\n\n[![Travis (.com)](https://img.shields.io/travis/com/favoloso/remarkable-admonitions.svg)](https://travis-ci.com/favoloso/remarkable-admonitions)\n[![Codecov](https://img.shields.io/codecov/c/github/favoloso/remarkable-admonitions.svg)](https://codecov.io/gh/favoloso/remarkable-admonitions)\n[![npm](https://img.shields.io/npm/v/remarkable-admonitions.svg?style=popout)](https://www.npmjs.com/package/remarkable-admonitions)\n\nAdds admonitions parsing support to Remarkable. (There's also a [React component](https://github.com/nebrelbug/react-admonitions))\n\n\n\n## Installation\n\nWith npm:\n\n```sh\nnpm install --save remarkable-admonitions\n```\n\nor with Yarn:\n\n```sh\nyarn add remarkable-admonitions\n```\n\n## Usage\n\n```js\nimport Remarkable from 'remarkable';\nconst md = new Remarkable();\n\nimport admonitions from 'remarkable-admonitions';\nmd.use(admonitions());\n\nmd.render(`\n:::caution\nBeware Ogre\n:::\n`);\n/* ->\n
\n
\n
🔥
caution
\n
\n
\n

Beware Ogre

\n
\n
\n*/\n```\n\nSupported admonition types are: `caution`, `note`, `important`, `tip`,\n`warning`.\n\nBy default block title is the admonition type. You can provide a custom title\nafter the opening tag:\n\n```md\n:::note This is my custom title\nA note.\n:::\n```\n\n### With Docusaurus\n\nIf you are using [Docusaurus](https://docusaurus.io), you can load the plugin\nin `siteConfig.js`:\n\n```js\nconst siteConfig = {\n // ...\n markdownPlugins: [\n // Highlight admonitions.\n require('remarkable-admonitions')({ icon: 'svg-inline' })\n ]\n};\n```\n\nThere is a style developed to match its visual appearence (the same you can see\nin the preview image up here). Due to Docusaurus [CSS loading system](https://docusaurus.io), you need to download the css from\n[docusaurus-admonitions.css](styles/docusaurus-admonitions.css) and place it\ninto your `custom/` folder.\n\n## Options\n\nYou may configure this plugin with the following options:\n\n| Option | Default | Description |\n| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`icon`** | `emoji` | Allows to use a different method to render admonition icons. By default it uses `emoji` (unicode Emojis). Choose `svg-inline` to use [Octicons](https://octicons.github.com). |" }