{"_id":"@bwagener/remark-slug","_rev":"2-95a48e38411b7c348572221fa82ca639","name":"@bwagener/remark-slug","dist-tags":{"latest":"4.2.4"},"versions":{"6.0.1":{"name":"@bwagener/remark-slug","version":"6.0.1","description":"remark plugin to add anchors to headings modified to handle Umlaute","license":"MIT","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","text","slug","id","github","npm"],"repository":{"type":"git","url":"git+https://github.com/BWagener/remark-slug.git"},"bugs":{"url":"https://github.com/remarkjs/remark-slug/issues"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},{"name":"Jayson Harshbarger","email":"hypercubed@gmail.com"},{"name":"Benedikt Wagener"}],"dependencies":{"github-slugger":"^1.0.0","mdast-util-to-string":"^1.0.0","unist-util-visit":"^2.0.0"},"devDependencies":{"browserify":"^17.0.0","nyc":"^15.0.0","prettier":"^2.0.0","remark":"^13.0.0-alpha.0","remark-cli":"^9.0.0","remark-preset-wooorm":"^8.0.0","tape":"^5.0.0","tinyify":"^3.0.0","unist-builder":"^2.0.0","unist-util-remove-position":"^3.0.0","xo":"^0.33.0"},"scripts":{"format":"remark . -qfo && prettier . -w --loglevel warn && xo --fix","build-bundle":"browserify . -s remarkSlug > remark-slug.js","build-mangle":"browserify . -s remarkSlug -p tinyify > remark-slug.min.js","build":"npm run build-bundle && npm run build-mangle","test-api":"node test","test-coverage":"nyc --reporter lcov tape test.js","test":"npm run format && npm run build && npm run test-coverage"},"prettier":{"tabWidth":2,"useTabs":false,"singleQuote":true,"bracketSpacing":false,"semi":false,"trailingComma":"none"},"xo":{"prettier":true,"esnext":false,"ignores":["remark-slug.js"]},"remarkConfig":{"plugins":["preset-wooorm"]},"gitHead":"677d499f726a6397e7af925f97b935d5d7836307","homepage":"https://github.com/BWagener/remark-slug#readme","_id":"@bwagener/remark-slug@6.0.1","_nodeVersion":"12.13.0","_npmVersion":"6.12.0","dist":{"integrity":"sha512-lgdurhbH3AoLENeTV0l6fe9gA6fo0g6UtdLvRCxSrlOyuSL5SW2Lmw264zjo5qD6fUQD/10QcNEKo+s6bq+wVQ==","shasum":"17c515e2064defe53c3e34338e475aac948f1687","tarball":"https://registry.npmjs.org/@bwagener/remark-slug/-/remark-slug-6.0.1.tgz","fileCount":4,"unpackedSize":9403,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfw38MCRA9TVsSAnZWagAACXkP+wVva31V74yvcmKucxlm\n6AE/d85tp9+u0DOujYMYkb9btM3/tIB8Lpw5eJ7KD4qoOvk4osQnhniEsY4P\nxtwtkAWG3ctVqUxgbgQukJ8j7AoaVm5ZUSlqKfS4eErksa1srLk/Hsk6HSxf\nuk1D+5/PLVRL3tcIvTXASlOeJi/4Qpm/4erv4HVENEvaU3DuJWTyYwXZXgC2\nHVL64rJXWFNYWXgfBKDdbheuoX9iYlXyck5bjgsf/dLacQrfuUTYLU5pzGC8\nBHSv9zIv7gw0DYRyR3gSV7X0OJpsU3dDMqpi/I6kMlX5NhtVSVfRNwqov0SI\nFYTknb285oMpSARVFUqtq/Ahj3SjJ7PL/bYjZ0aQrVIk22DKgdGhQlo6xeYe\nnWlzwLLXtt4zS6UnSNLaXhWNY8u5p27aiWVA9gTX17T8HLnb8BJY6buR9+Ra\nEMq9gy73OHaIx9AeOwfdMPFsuppLQYGjl8jodyXNfF3xKWV3FD0OnuiWvFQp\n8F1IazYw+HtMttlSUKpMwvsclGlxd7cxhhJ9JRb2WzjWpBSKBhhNAEMxTnb3\n1o40MmNRSiQicGkxZpV4bU89BACxVVFwYDk9tm0k7+/dQ/RLVIldT6ubE1Nd\nOy7dkiZGE7Lmkv7IX5caZMPsYdHJAGwmz9Gl82MvzH2Bkz94SROIHvCcm38x\nZVmn\r\n=5uND\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCk6R8Jf1ESKJhEwxbd1HPYTND9ZtXKGjgYQ0zn9EeQagIhAL5p8Jxnz55/zUGaUEp7lA8OddDoD0ZN06S5A0Edou3d"}]},"_npmUser":{"name":"bwagener","email":"wagenerbene@gmail.com"},"directories":{},"maintainers":[{"name":"bwagener","email":"wagenerbene@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-slug_6.0.1_1606647563917_0.9082112193824563"},"_hasShrinkwrap":false},"4.2.4":{"name":"@bwagener/remark-slug","version":"4.2.4","description":"remark plugin to add anchors to headings","license":"MIT","keywords":["text","markdown","slug","id","github","npm","remark"],"repository":{"type":"git","url":"git+https://github.com/BWagener/remark-slug.git"},"bugs":{"url":"https://github.com/remarkjs/remark-slug/issues"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},{"name":"Jayson Harshbarger","email":"hypercubed@gmail.com"},{"name":"Benedikt Wagener"}],"dependencies":{"github-slugger":"^1.0.0","mdast-util-to-string":"^1.0.0","unist-util-visit":"^1.0.0"},"devDependencies":{"browserify":"^14.0.0","esmangle":"^1.0.0","nyc":"^11.0.0","remark":"^7.0.0","remark-cli":"^3.0.0","remark-preset-wooorm":"^3.0.0","tape":"^4.0.0","unist-builder":"^1.0.2","unist-util-remove-position":"^1.1.0","xo":"^0.18.0"},"scripts":{"build-bundle":"browserify index.js --no-builtins -s remarkSlug > remark-slug.js","build-mangle":"esmangle remark-slug.js > remark-slug.min.js","build-md":"remark . -qfo","build":"npm run build-md && npm run build-bundle && npm run build-mangle","lint":"xo","test-api":"node test.js","test-coverage":"nyc --reporter lcov tape test.js","test":"npm run build && npm run lint && npm run test-coverage"},"xo":{"space":true,"esnext":false,"ignores":["remark-slug.js"]},"remarkConfig":{"plugins":["preset-wooorm"]},"gitHead":"5c722ecbd787e0401270a4b7806b647aa02926eb","homepage":"https://github.com/BWagener/remark-slug#readme","_id":"@bwagener/remark-slug@4.2.4","_nodeVersion":"12.13.0","_npmVersion":"6.12.0","dist":{"integrity":"sha512-bV8lrhaFO4jWsBDLwP4UtGk9Eh769sq+73nZ/K4L9BOs1M6M+nrJMaLt0dtHP+nYeDHVU/193fshWYamxk00jw==","shasum":"7738d34eb75d71e4663b2fc59f1966b479a2bb6e","tarball":"https://registry.npmjs.org/@bwagener/remark-slug/-/remark-slug-4.2.4.tgz","fileCount":4,"unpackedSize":7212,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfw4NbCRA9TVsSAnZWagAAb5QP/AvbPFz1OGbyGhhE9WP7\nzXO7G2JSsCnZaMofqJYZsK4W7Ncj1p9Tl5UWVBFkKpLrUsTDeFp1vhiaRrFB\nBF3v7OuWq8oMS9BW8x8hhQx1gspyhaRG6cNWAcPlXIXw8AON5RTEV5aFJkMe\nImXFgdovUjb/2eERlDLiL+hoPhuFIeJYT/FsQntIFjkQtqo3C0QkVqvLQY6I\njCsgXEFHvUgCDZxffLNW6lgrOV0zlm1QqJ9hkFask3eQR9haO5y24Bg5uKqW\nzoWqj+4Oew8ffk8hKJ/DaWD/HdfRKrTlCXL+ckOnKDg8KoQI69eb7BNRnwZh\nNnIJrlvJYN3G44VyhSZZGmnDtBh8Y+5B4OEzzMvjn7kCRTBMBJlv3AkBNYp6\nHg7uJpn27q7fNscUU1NBCfp4bGnmX52xZXbpeNAn+yKIYvr26jnIgTorkPea\nSkrbgEImTCGnHQ7NxVrm0tSSMBRln4YWWqLWof/N62lgV4RP5q+SfanVRVik\nXzIFgXZiCcrmhgif8RsuPjr7YFF/YI7twwXmi7GGG7/+goDbfX7TRclgS1SB\npJBSCjcYahG7SB3qaGERzq+lvBw1rC8sVoTb4aA7PEQbBV8G3fmc2p7ek7VK\nThWjY8whp+XTg+Q6oT04QJvZwkwEnSB6dnVSS4rcfZ2rIS1Z6DmtywuNi0AZ\n5o38\r\n=3mTv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDsnfRXBF3NCcy6TrmcaF8iWaCL+it3GPKau+a/lVuKUQIgCq7s3F934LL4J65YROiMClfhjl2WymjQMdLRCuBcJfI="}]},"_npmUser":{"name":"bwagener","email":"wagenerbene@gmail.com"},"directories":{},"maintainers":[{"name":"bwagener","email":"wagenerbene@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-slug_4.2.4_1606648666450_0.812498312290963"},"_hasShrinkwrap":false}},"time":{"created":"2020-11-29T10:59:23.881Z","6.0.1":"2020-11-29T10:59:24.032Z","modified":"2022-04-04T21:17:20.202Z","4.2.4":"2020-11-29T11:17:46.701Z"},"maintainers":[{"name":"bwagener","email":"wagenerbene@gmail.com"}],"description":"remark plugin to add anchors to headings","homepage":"https://github.com/BWagener/remark-slug#readme","keywords":["text","markdown","slug","id","github","npm","remark"],"repository":{"type":"git","url":"git+https://github.com/BWagener/remark-slug.git"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},{"name":"Jayson Harshbarger","email":"hypercubed@gmail.com"},{"name":"Benedikt Wagener"}],"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"bugs":{"url":"https://github.com/remarkjs/remark-slug/issues"},"license":"MIT","readme":"# remark-slug [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]\r\n\r\nAdd anchors to [**remark**][remark] heading nodes using GitHub’s\r\nalgorithm.\r\n\r\n> :warning: This is often useful when compiling to HTML.  If you’re doing that,\r\n> it’s probably smarter to use [`remark-rehype`][remark-rehype] and\r\n> [`rehype-slug`][rehype-slug] and benefit from the [**rehype**][rehype]\r\n> ecosystem.\r\n\r\n## Installation\r\n\r\n[npm][]:\r\n\r\n```bash\r\nnpm install remark-slug\r\n```\r\n\r\n## Usage\r\n\r\nSay we have the following file, `example.md`:\r\n\r\n```markdown\r\n# Lorem ipsum 😪\r\n\r\n## dolor—sit—amet\r\n\r\n### consectetur &amp; adipisicing\r\n\r\n#### elit\r\n\r\n##### elit\r\n```\r\n\r\nAnd our script, `example.js`, looks as follows:\r\n\r\n```javascript\r\nvar fs = require('fs');\r\nvar unified = require('unified');\r\nvar markdown = require('remark-parse');\r\nvar slug = require('remark-slug');\r\nvar remark2rehype = require('remark-rehype');\r\nvar html = require('rehype-stringify');\r\n\r\nunified()\r\n  .use(markdown)\r\n  .use(slug)\r\n  .use(remark2rehype)\r\n  .use(html)\r\n  .process(fs.readFileSync('example.md'), function (err, file) {\r\n    if (err) throw err;\r\n    console.log(String(file));\r\n  });\r\n```\r\n\r\nNow, running `node example` yields:\r\n\r\n```html\r\n<h1 id=\"lorem-ipsum-\">Lorem ipsum 😪</h1>\r\n<h2 id=\"dolorsitamet\">dolor—sit—amet</h2>\r\n<h3 id=\"consectetur--adipisicing\">consectetur &#x26; adipisicing</h3>\r\n<h4 id=\"elit\">elit</h4>\r\n<h5 id=\"elit-1\">elit</h5>\r\n```\r\n\r\n## API\r\n\r\n### `remark.use(slug)`\r\n\r\nAdds slugs to markdown headings.\r\n\r\nUses [**github-slugger**][ghslug] (thus creating GitHub style `id`s).\r\n\r\nSets `data.id`, `data.hProperties.id` on heading nodes.  The first can be\r\nused by any plugin as a unique identifier, the second tells **remark-html**\r\nto use its value as an `id` attribute. **remark-slug** does not overwrite\r\nthese values when they already exist.\r\n\r\n## Related\r\n\r\n*   [`rehype-slug`][rehype-slug] — Add slugs to headings in HTML\r\n\r\n## License\r\n\r\n[MIT][license] © [Titus Wormer][author]\r\n\r\n<!-- Definitions -->\r\n\r\n[build-badge]: https://img.shields.io/travis/wooorm/remark-slug.svg\r\n\r\n[build-status]: https://travis-ci.org/wooorm/remark-slug\r\n\r\n[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/remark-slug.svg\r\n\r\n[coverage-status]: https://codecov.io/github/wooorm/remark-slug\r\n\r\n[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg\r\n\r\n[chat]: https://gitter.im/wooorm/remark\r\n\r\n[license]: LICENSE\r\n\r\n[author]: http://wooorm.com\r\n\r\n[npm]: https://docs.npmjs.com/cli/install\r\n\r\n[remark]: https://github.com/wooorm/remark\r\n\r\n[ghslug]: https://github.com/Flet/github-slugger\r\n\r\n[rehype-slug]: https://github.com/wooorm/rehype-slug\r\n\r\n[remark-rehype]: https://github.com/wooorm/remark-rehype\r\n\r\n[rehype]: https://github.com/wooorm/rehype\r\n","readmeFilename":"readme.md"}