{"_id":"remark-burger","_rev":"2-cfcff3d07598a37c172707eb84ab7664","name":"remark-burger","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"remark-burger","version":"1.0.0","description":"A remark plugin that extracts text sandwiched between 2 customizable markers & turns it into a node. A transformer or stringify function can then do whatever with the new node type.","main":"index.js","scripts":{"test":"jest"},"author":{"name":"Derek Nguyen","email":"derek@penandpillow.com"},"repository":{"type":"git","url":"git+https://github.com/d4rekanguok/remark-burger.git"},"keywords":["remark","markdown","text"],"license":"ISC","devDependencies":{"eslint":"^5.16.0","jest":"^24.7.1","remark":"^10.0.1","unist-util-visit":"^1.4.0"},"gitHead":"edf6e42c4ba31b8bdfe270552a98c2f8b0b56b25","bugs":{"url":"https://github.com/d4rekanguok/remark-burger/issues"},"homepage":"https://github.com/d4rekanguok/remark-burger#readme","_id":"remark-burger@1.0.0","_nodeVersion":"11.14.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-5kmsrdSwajpC92puE52TWdQub1m3K/Phuwp0oyLieMDabbUUqM+/1TaukHx0KrOUwjSRYCvCeaW3ROCoX+xhmw==","shasum":"6cddfe0cecea5c9a96ba2a2edc52f4e9e93daa61","tarball":"https://registry.npmjs.org/remark-burger/-/remark-burger-1.0.0.tgz","fileCount":5,"unpackedSize":5514,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcuWI3CRA9TVsSAnZWagAAZA4P/2XoOeczawMvykhcwc1w\nvCVDdDe+tV3sOKVRnDkFkAOzxTas1QkdbxF/pjfnd11dH9641Qq5oX8Ru3aQ\nYWYd2NMArzSjlArw1M0i66yDQ3JtSz9391VPfyBKZEfB9NPGkBLb9sMBK3mQ\nQ0Z2XI7waxtjvXrzOHG9C5St9lz3aR+jozX7pARAgwprWa00QjVTWUKoF6XS\nP+FmMYfqOCiOH2pGz/7wFQrwyJwUD7iCsBr5mcsZur4trjYKhoE83cz+SsiE\nM2WTsKYzTzU6Luq51H+meQUx6g2Gb2PjcdMsqfvzYYZDj0mh7YAFbSzOcobO\nzNEnPfP6pn30GGaMVVQrsD0usDNMyGIm+5OcedykLEdWsOQ8vzIs0w6mwQNS\nuu2A7l8hl0NL9k9hqLaxmBlSAqt5/3BEopy9seV3EtXnBXMx5hLw+U4Y1pPZ\nXz9mrewf/2jw6AN26dFyDqjKWie6fmRCAZNWoe9qpNo158W1vZLxee64cSX8\nN4ZKkQM9uzG4buCV+s2HRzav0dhvnNlBnh6vwmjastvf1Qsyt1JTO7vMfOyU\n6sf0kV4Hat4v2eLydUb6UPnA1EvgDKdEBTyrdtSNVv73OF4pQ4bX7PVQWlg7\n9iQJodbUzsUersYWjoSbHmZ3Vi7l9ZKKmJvmX/Ih4KMXG8RRFfew9kc4VL4Q\nxCNa\r\n=K43R\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHbYAblra7hji9fU1PVdU8vOTHoQMKNIcs40ava9iK7GAiBYYZS1NLYKJxTR5Nind4yoU4GilMcsiXt5IzKghT1W6Q=="}]},"maintainers":[{"name":"d4rek","email":"derek@penandpillow.com"}],"_npmUser":{"name":"d4rek","email":"derek@penandpillow.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-burger_1.0.0_1555653174772_0.20699029781032086"},"_hasShrinkwrap":false},"1.0.1":{"name":"remark-burger","version":"1.0.1","description":"extracts text sandwiched between markers ","main":"index.js","scripts":{"test":"jest"},"author":{"name":"Derek Nguyen","email":"derek@penandpillow.com"},"repository":{"type":"git","url":"git+https://github.com/d4rekanguok/remark-burger.git"},"keywords":["remark","markdown","text"],"license":"ISC","devDependencies":{"eslint":"^5.16.0","jest":"^24.7.1","remark":"^10.0.1","unist-util-visit":"^1.4.0"},"dependencies":{},"gitHead":"6eb84e9604e0d8bdcda2aca48b4ad0e7b8dd9cc2","bugs":{"url":"https://github.com/d4rekanguok/remark-burger/issues"},"homepage":"https://github.com/d4rekanguok/remark-burger#readme","_id":"remark-burger@1.0.1","_nodeVersion":"11.14.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-F91SyEzat4hBkWsWElHIvMcCQuWoSeZXTuR4DmLvhUIjYkzzVLaX6GRxhkiDrZb/9asvTrYzwEr9HvxN1tqs9Q==","shasum":"cda57d4bc1e952ae86b2407fbcf36492ab352106","tarball":"https://registry.npmjs.org/remark-burger/-/remark-burger-1.0.1.tgz","fileCount":6,"unpackedSize":9564,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdmu4ICRA9TVsSAnZWagAAAYoP/2E7sDAz1TgUR/z8AxCA\n1crsys3bEqUUEyCkF1bdVVTs9lIlyczQO5h0xfLE2BaL1n5Cs7gPp0uAAcMT\nVn4umiOyZ70z5eoZFGBcHjY+NS+blpQUg8ogDEJ80/6kwLBWlTNL57TwrBOh\n7rxc34xKmGZI7fy7gp7TsZYUfqTRrqbv+KJ63NmP4PJgCVJYeg1nI+Eswymv\nAg2v4/NUffZ8hbz/PghaiRvEJTKDj3vhSUHN3JgMcbsuLK8RlJhvm3leLG69\nS6v8S7imzMCNNEp7YWx4fj6LlVt8XJbQATlX/88thM40LtXpQtr0uhlnSkDA\nl7hLJPSoaK6rFCy7cxgUWAoYvrSu1MT2Cn+DIaBCyoh/QLeI5Y5XcPP/RULe\nVXKgGKnLc7nEa/meL3c1BjGOCARZqj6iH7VSdS8CV5x25I6VjTJQUYtUhSwW\njeGRcggrvC++hUVjtpiKzNItiVE7W00pxL6NfYdOo1LmIz9Yc87ULVeSQy69\nVzMuga8I9IjR2tOjhrwiAdJNwf2miC0F0khHhb3FhlYnZu3i8Z6fxOErHkof\nPTeIQwqhDZ1Eccsr2d7hXtDgZG9sp48PdpUTS8A9v9J08LOJiGdpVVGtMFrb\nM9KxFkFSLQ1+BJt2OY5Rw1ax45y2fue7S7D44+oxyRWwtR36LkRPIGv+NMng\nu3+h\r\n=1CFQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH7pMW1xtTGbYEFC5j+czrCEP7GrILFZZ9nOZCJehkbqAiAxzob/qy/pZh4U7Ke4NXI8mujg0wP6vLhGmXJBu2a8BQ=="}]},"maintainers":[{"name":"d4rek","email":"derek@penandpillow.com"}],"_npmUser":{"name":"d4rek","email":"derek@penandpillow.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-burger_1.0.1_1570434568050_0.713407831258376"},"_hasShrinkwrap":false}},"time":{"created":"2019-04-19T05:52:54.771Z","1.0.0":"2019-04-19T05:52:54.936Z","modified":"2022-05-15T18:01:11.245Z","1.0.1":"2019-10-07T07:49:28.251Z"},"maintainers":[{"name":"d4rek","email":"derek@penandpillow.com"}],"description":"extracts text sandwiched between markers ","homepage":"https://github.com/d4rekanguok/remark-burger#readme","keywords":["remark","markdown","text"],"repository":{"type":"git","url":"git+https://github.com/d4rekanguok/remark-burger.git"},"author":{"name":"Derek Nguyen","email":"derek@penandpillow.com"},"bugs":{"url":"https://github.com/d4rekanguok/remark-burger/issues"},"license":"ISC","readme":"# remark-burger 🍔\n\nA remark plugin that extracts text sandwiched between 2 customizable markers & turns it into a node. A transformer or stringify function can then do whatever with the new node type.\n\n```bash\nyarn add remark-burger\nnpm install remark-burger\n```\n\n---\n```js\nconst burger = require('remark-burger')\n\nremark()\n  .use(burger)\n  .parse('hello [[world]]')\n\n//\n//  { type: 'patty',\n//    value: '',\n//    data: { content: 'world' },\n//    position: {\n//      start: { line: 1, column: 7, offset: 6 },\n//      end: { line: 1, column: 14, offset: 13 },\n//      indent: [] } }\n\n```\n\n## Options\n\n```ts\ninterface RemarkBurgerOptions {\n  beginMarker?: string;\n  endMarker?: string;\n  pattyName?: string;\n  onlyRunWithMarker?: boolean;\n  insertBefore?: MarkdownMethods;\n}\n```\n\n#### beginMarker & endMarker\n\nThe default pair is `[[` & `]]`.\n\n```js\nremark()\n  .use(burger, {\n    beginMarker: '<<',\n    endMarker: '>>',\n  })\n  .parse('hello <<world>>')\n```\n\nIf the marker pair conflicts with markdown default syntax, it won't work. For example, this won't work:\n\n```js\nremark()\n  .use(burger, {\n    beginMarker: '`',\n    endMarker: '`',\n  })\n  .parse('hello `world`')\n```\n\nIt is because by default, `remark-burger`'s tokenizer priority is very low so it won't be conflicted with markdown syntax. This can be configured with [`insertBefore`](#insertBefore) options.\n\n#### pattyName\n\nThe default name is `patty`, but it can be configured to be whatever.\n\n#### onlyRunWithMarker\n\nThis plugin won't run if no marker is declared. Default: `false`. The example below won't work:\n\n```js\n// doesn't work\nremark()\n  .use(burger, {\n    onlyRunWithMarker: true\n  })\n  .parse('hello [[world]]')\n```\n\n#### insertBefore\n\nChange the order in which the parser will call this plugin's tokenizer. Here's the order list:\n\n```\nescape\nautoLink\nurl\nhtml\nlink\nreference\nstrong\nemphasis\ndeletion\ncode\nbreak\n<- remark-burger ->\ntext\n```\n\nBy default, `remark-burger`'s tokenizer is run before `text`. You can change this by passing in one of the method listed above. For example, this works:\n\n```js\nremark()\n  .use(burger, {\n    beginMarker: '`',\n    endMarker: '`',\n    insertBefore: 'code',\n  })\n  .parse('hello `world`')\n```","readmeFilename":"readme.md"}