{"_id":"@vcarl/remark-headings","_rev":"3-a652106f255866e45e93ed197f4400b1","name":"@vcarl/remark-headings","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.0":{"name":"@vcarl/remark-headings","version":"0.0.0","description":"Remark plugin to extract heading metadata while processing markdown files","license":"MIT","keywords":["unist","mdast","remark","markdown","headings"],"repository":{"type":"git","url":"git+https://github.com/vcarl/remark-headings.git"},"bugs":{"url":"https://github.com/vcarl/remark-headings/issues"},"author":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"contributors":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","dependencies":{"mdast-util-to-string":"^3.1.0","unist-util-visit":"^4.0.0"},"devDependencies":{"@types/tape":"^4.0.0","c8":"^7.0.0","prettier":"^2.0.0","remark":"^14.0.0","remark-cli":"^10.0.0","remark-gfm":"^3.0.0","remark-parse":"^10.0.0","remark-preset-wooorm":"^9.0.0","remark-stringify":"^10.0.2","remark-usage":"^10.0.0","tape":"^5.0.0","type-coverage":"^2.0.0","typescript":"^4.5.4","unified":"^10.0.0","unist-builder":"^3.0.0","xo":"^0.45.0"},"scripts":{"prepack":"tsc","format":"remark . -qfo && prettier . -w --loglevel warn","test-api":"node test/index.js","test-coverage":"c8 node test/index.js","test":"npm run test-coverage"},"prettier":{},"gitHead":"e1c2f6da9620123aa000bea59b962173c54e8533","homepage":"https://github.com/vcarl/remark-headings#readme","_id":"@vcarl/remark-headings@0.0.0","_nodeVersion":"16.13.0","_npmVersion":"8.1.4","dist":{"integrity":"sha512-00X+jD8rDN+onEpPHUiMqaL8PYSA9V4ekdCjySnrk7oTe1x2W+68ir6ubGos9U9H9kU75O6nG0hDC7sOObFzSA==","shasum":"91dadcd418390630ff0ac923dd9b8f87e5fa3525","tarball":"https://registry.npmjs.org/@vcarl/remark-headings/-/remark-headings-0.0.0.tgz","fileCount":5,"unpackedSize":4324,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhwkTJCRA9TVsSAnZWagAAaAkP/1s6T8yeNLkUcfqB08qD\nXx4px38AqhnsiPuwGI2KekoVa0nTYOE5CimdRd9cl561bUoONhz+yNqRMOlO\nJjkFxkBlBHE0vWRMRBGDZT2+IzKlBLqt7BqYMWkjHYtoxcuvinJcAojC7zYf\nj6oCvUSdDhU8vgCNpJpUWBASg//EZKZnfsyCkossfN42/2zm8Qv62SPpgIRb\n7mPpOsgdTh/P74zhYyxQ2rUrxUXHJRzGon+ZpYsL7xEdgf+MNhWyleJvbI2r\nnxl1uta85MJ7N2eKGdWwU1womKJ9oc+NvFrY9W5eACC0wCrtpuCwhUlR/IYn\n/Zb5dp5FxAUUxbHaBKFUmpFqSW147y90ohKuwZKnMRaNylMFFXoq5R5cw0N+\nWTk9YTOQHrU89Lmvlda2cWN2upZQT1sXxB+RKq28rm2ppUyrPnJ5jaqODtcL\nEcCIZWmDtWcabXRdCxNhJU1yZXgG1ELYyR9X5Blw5pe1kR2gGPwY2zWhVZFT\nGUNq3iWjWXxuzhMHMTvBRos270S7UUIJkBO6KtJVFPnG6SnblmeNO7p9vldv\noMpUdcrUChjwrH6TrxIfs8HZRRFZxnWubzFvlDeCnJ9rWd05OquXCX8A7bJ+\nf7JKexGcSCiBJqmjITudKE6+EUr3kbsRkEn7sg2Ntzw7VXF/noB+QZTaWbJK\nnvUN\r\n=mm5Z\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE8pH+LuV7UkuqYQF0PULRaa6jcc8CI+CA9bqL5koxY6AiEAquR997RFhu86G0SqizcJ2ay7vv+zV5ZKZDhA5iECjYI="}]},"_npmUser":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"directories":{},"maintainers":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-headings_0.0.0_1640121545651_0.9048330488499676"},"_hasShrinkwrap":false},"0.0.1":{"name":"@vcarl/remark-headings","version":"0.0.1","description":"Remark plugin to extract heading metadata while processing markdown files","license":"MIT","keywords":["unist","mdast","remark","markdown","headings"],"repository":{"type":"git","url":"https://github.com/vcarl/remark-headings.git"},"bugs":{"url":"https://github.com/vcarl/remark-headings/issues"},"author":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"contributors":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","dependencies":{"mdast-util-to-string":"^3.1.0","unist-util-visit":"^4.0.0"},"devDependencies":{"@types/tape":"^4.0.0","c8":"^7.0.0","prettier":"^2.0.0","remark":"^14.0.0","remark-cli":"^10.0.0","remark-gfm":"^3.0.0","remark-parse":"^10.0.0","remark-preset-wooorm":"^9.0.0","remark-stringify":"^10.0.2","remark-usage":"^10.0.0","tape":"^5.0.0","type-coverage":"^2.0.0","typescript":"^4.5.4","unified":"^10.0.0","unist-builder":"^3.0.0","xo":"^0.45.0"},"scripts":{"prepack":"tsc","format":"remark . -qfo && prettier . -w --loglevel warn","test-api":"node test/index.js","test-coverage":"c8 node test/index.js","test":"npm run test-coverage"},"prettier":{},"licenseText":"(The MIT License)\n\nCopyright (c) 2021 Carl Vitullo <carl.vitullo@gmail.com>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","_id":"@vcarl/remark-headings@0.0.1","dist":{"shasum":"d530a17b1c980ce4223ec147341e6943fb6efa1b","integrity":"sha512-tLT3G+n2mZwqEIGCpnRaXSVFFvQz8zhFLM2Ik0RPPgDFhGZPNrpglNw9U6xRdVroboV7lnEHno6IVqZZJh/52g==","tarball":"https://registry.npmjs.org/@vcarl/remark-headings/-/remark-headings-0.0.1.tgz","fileCount":6,"unpackedSize":4585,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhwlIACRA9TVsSAnZWagAA9IIQAJwNRDte1djB7x7bGjb7\nJwtwIX7uNABt/S5/+vWgjH24KAEs/NCCXgCcU4CJa2X4OEl/E6/8HEHudBVF\nKJohxg05IPBKU82E4i6xbsK8FgiJABl01FKFnGMUDYZxo4/V2zCQNx7qzwDf\nNEg7L4AHmH2tLFTC9CSRPeCm5JyjqzOlh5GtTf5t6Y0QTY4J3BlEMPvuFR0C\nvjEfjCBjWWj0m+MR6trJteDx8ZYwODObbGa0qgdj3E4qdQKEedf28BTBwzIB\nsVBPEifYXhybCm6L4uwadMyVbbmEIyBBrQHKwcXmvz99asYvcZrrKxlbugVw\n+40n8NCgdchbRA9Z0GCXm1fRxAt9NEmgCchlvT6KuCHFgNHFCqjmz0jw8UO/\nWVV21kuqjlqIKu2dbnBBJXLgKXmCzyqPWZxcWlGlEkMhYDHN55zTGNH/aFZb\nzlt9oN3PwAVKAH3wU6Tqh9DVe+T59h6iL8IFzPQn4FH9fM8lZn4Q/w93ueFu\nLekDesAnZn4V4SEAUCU6e1FiCUwxWOQnsxm0bGzBQKzqnpHQWyrAV/lDHBOw\ngDbkAPuw3aRbiABQbuDNLa1HbCJjSYPCjE1Pdo9STnjR96dxrUhUkGpi0ooo\nwB20SVZv0a9+/sCKq3BYS7xWSIaONbTDtgMojb3Yx1JwMFLmG/MW4pHVmMbX\n4xZc\r\n=UzRl\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDKC2LwbjAGruKGC/PQi0rH8a3zlpdieqcW9ooMozq1zAIhAIS87XEb+VKTziUgurmLBYwFQtugMUID8UAn+4vD67rR"}]},"_npmUser":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"directories":{},"maintainers":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-headings_0.0.1_1640124928235_0.2457955191923895"},"_hasShrinkwrap":false},"0.1.0":{"name":"@vcarl/remark-headings","version":"0.1.0","description":"Remark plugin to extract heading metadata while processing markdown files","license":"MIT","keywords":["unist","mdast","remark","markdown","headings"],"repository":{"type":"git","url":"git+https://github.com/vcarl/remark-headings.git"},"bugs":{"url":"https://github.com/vcarl/remark-headings/issues"},"author":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"contributors":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"sideEffects":false,"type":"module","main":"index.js","types":"index.d.ts","dependencies":{"mdast-util-to-string":"^3.1.0","unist-util-visit":"^4.0.0"},"devDependencies":{"@types/tape":"^4.0.0","c8":"^7.0.0","prettier":"^2.0.0","remark":"^14.0.0","remark-cli":"^10.0.0","remark-gfm":"^3.0.0","remark-parse":"^10.0.0","remark-preset-wooorm":"^9.0.0","remark-stringify":"^10.0.2","remark-usage":"^10.0.0","tape":"^5.0.0","type-coverage":"^2.0.0","typescript":"^4.5.4","unified":"^10.0.0","unist-builder":"^3.0.0","xo":"^0.45.0"},"scripts":{"prepack":"tsc","format":"remark . -qfo && prettier . -w --loglevel warn","test-api":"node test/index.js","test-coverage":"c8 node test/index.js","test":"npm run test-coverage"},"prettier":{},"gitHead":"798c8e2bf9e8bdf91941b8243bce6beec6bde525","homepage":"https://github.com/vcarl/remark-headings#readme","_id":"@vcarl/remark-headings@0.1.0","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-ffQxJUcapJ9Bk+fiGN49YJ9RaYMibrSTSezB1Fcrtu+0YSZxA3bsaLlIv1u/4sjPIeW/BKrs4xtMT3l3P9Ba5Q==","shasum":"b5831c3f16d8b2570872f554ba509437ec507a1e","tarball":"https://registry.npmjs.org/@vcarl/remark-headings/-/remark-headings-0.1.0.tgz","fileCount":5,"unpackedSize":5272,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDOZeHr4buU5+PI+E6u+jfn/zHB4ez3ct/LPPOv54p23AiASDq+2X0uHECreZvf8fAtA+bbvsrKlnlXS1Mzw9GjOBQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjSS68ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpwVw//Z6AY6FdkYd5DG9FQwEbx2ZsNLlspIBISBDae44mdck7uzJTX\r\nNqZTqUR7CxxN/rA37+BFoc68p+XnGsOck27a1tkfKD3UbjdVseNQPH2Dh8It\r\nqiScA0zfb72yl1Juawz8WB8xQ0+lMkS80OA74AnKqdjDejkVkJ915rpELQdd\r\n4qJRzCCyqs1Vg4yWSIuVMd+SEmPKXZYAo10OXYfdVb+BGlUKPDXI2Fs3rACC\r\nAFnDMKVkW4t/s0ZFs6A3aGINHp2cPjbahO9yghZ4k/l1OvoKVzHI7nVUdV0+\r\ns7i06z5AiAz9VE1GfsDQfGPec4f/zVrMAQUSZTCbcjG2FiYIzHirDfw9Ca5x\r\n4DuLjSUUEY87iIDn7iE1A8wAibWOZy1t8lVt18/D0HR6S31tI2coe4fnPMrR\r\nYBrzPpS5CtOFt9G0lV8kMN5UdVBUjmVM0tq1fbOKWp2DkTmdQgr+xPwVkHfA\r\nbafqbJ4DLisGFLmgC4G1z731fH7cK0X5zl2Q+Z/RhHCuJIojGp0Tzxlqw71Q\r\nYIO4aGyn61KU2OyT0VL0PXxOWyfPOoUMChrKUNzYc1/TcHGb27yyIe02Rr7Q\r\nP9j8S5DoB0WkOCvHCg7RO10UUijMIrUnsOj46UrydDURANUxsr5S0GljSmHC\r\nac53XEjCsub8R3HKAewI16YIfZ/01CJyteI=\r\n=ej0N\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"directories":{},"maintainers":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-headings_0.1.0_1665740476213_0.3945873193281293"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-21T21:19:05.606Z","0.0.0":"2021-12-21T21:19:05.833Z","modified":"2022-10-14T09:41:16.527Z","0.0.1":"2021-12-21T22:15:28.369Z","0.1.0":"2022-10-14T09:41:16.420Z"},"maintainers":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"description":"Remark plugin to extract heading metadata while processing markdown files","keywords":["unist","mdast","remark","markdown","headings"],"repository":{"type":"git","url":"git+https://github.com/vcarl/remark-headings.git"},"contributors":[{"name":"vcarl","email":"carl.vitullo@gmail.com"}],"author":{"name":"vcarl","email":"carl.vitullo@gmail.com"},"bugs":{"url":"https://github.com/vcarl/remark-headings/issues"},"license":"MIT","readme":"# remark-headings\n\nA remark plugin to add metadata about headings to the parsed output.\n\n## Install\n\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):\nNode 12+ is needed to use it and it must be `import`ed instead of `require`d.\n\n```sh\nyarn add @vcarl/remark-headings\n```\n\n## Use\n\nRunning:\n\n```js\nimport remarkHeadings from '@vcarl/remark-headings';\n\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport remarkStringify from \"remark-stringify\";\n\nconst processor = unified()\n  .use(remarkParse)\n  .use(remarkStringify)\n  .use(remarkHeadings);\n\nconst input = fs.readFileSync(\"input.md\");\n\n/*\n# Heading 1\n## Heading 2\n### Heading 3\n*/\nconst vfile = await processor.process(input);\n\nconsole.log(vfile.data.headings)\n```\n\nYields:\n\n```javascript\n[\n  {\"depth\": 1, \"value\": \"Heading 1\"},\n  {\"depth\": 2, \"value\": \"Heading 2\"},\n  {\"depth\": 3, \"value\": \"Heading 3\"},\n]\n```\n\nAs a courtesy, any other data found to be attached to the node by other plugins will be forwarded through. For instance if you're using [`remark-heading-id`](https://github.com/imcuttle/remark-heading-id), that custom ID will look like:\n\n```javascript\n[\n  {\"depth\": 1, \"value\": \"Heading 1\", \"data\": {\"id\": \"custom-id\"}},\n  {\"depth\": 2, \"value\": \"Heading 2\"},\n  {\"depth\": 3, \"value\": \"Heading 3\"},\n]\n```\n\n\n## License\n\n[MIT][license] © [Carl Vitullo][author]\n","readmeFilename":"readme.md","homepage":"https://github.com/vcarl/remark-headings#readme"}