{"_id":"@mapbox/rehype-highlight-code-block","_rev":"198-f52b15b331604e35336d9d38af9ea096","name":"@mapbox/rehype-highlight-code-block","description":"rehype plugin that finds code blocks in HTML and lets you highlight them","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"@mapbox/rehype-highlight-code-block","description":"rehype plugin that finds code blocks in HTML and lets you highlight them","version":"0.1.0","main":"index.js","scripts":{"precommit":"lint-staged","lint":"eslint *.js test lib","format":"prettier --single-quote --write '{,lib/**/,test/**/}*.js'","test-jest":"jest","pretest":"npm run lint","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/mapbox/rehype-highlight-code-block.git"},"keywords":["rehype","rehype-plugin","syntax-highlighting","highlight","html"],"author":{"name":"Mapbox"},"license":"MIT","bugs":{"url":"https://github.com/mapbox/rehype-highlight-code-block/issues"},"homepage":"https://github.com/mapbox/rehype-highlight-code-block#readme","lint-staged":{"{,lib/**/,test/**/}*.js":["eslint","prettier --single-quote --write","git add"]},"jest":{"coverageReporters":["json","lcov","text","html"],"resetMocks":true},"devDependencies":{"dedent":"^0.7.0","eslint":"^4.1.1","eslint-plugin-node":"^5.1.0","husky":"^0.14.1","jest":"^20.0.4","lint-staged":"^4.0.0","prettier":"^1.5.2","rehype":"^5.0.0"},"dependencies":{"hast-util-from-parse5":"^2.0.1","hast-util-to-string":"^1.0.0","parse5":"^3.0.2","unist-util-visit":"^1.1.3"},"gitHead":"6a37c3bdcaf5282747ff00f1bbc5440b2bcf26a2","_id":"@mapbox/rehype-highlight-code-block@0.1.0","_npmVersion":"5.0.4","_nodeVersion":"8.1.2","_npmUser":{"name":"lshig","email":"liz.shigetoshi@mapbox.com"},"dist":{"integrity":"sha512-KY/oObhBN67uEChmwMU2lvmeNo7ew7k3Jw8Q7zB9miaLlrt181D66j3/clDu9AslA4ZhQ7KKxq5RldqwpgUT6g==","shasum":"d2b30d32b3c3112e62680baea4ca0baed8fda67a","tarball":"https://registry.npmjs.org/@mapbox/rehype-highlight-code-block/-/rehype-highlight-code-block-0.1.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD7lAWk22FVy2jUV1R5Y+5tthD9a9cji7kL3b0bN6SFWgIhALQsra8UB8o7U37lrNLWt+b3FagTvkhlERFVE7OH0elA"}]},"maintainers":[{"name":"lshig","email":"liz.shigetoshi@mapbox.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rehype-highlight-code-block-0.1.0.tgz_1499292465283_0.7204915427137166"},"directories":{}},"1.0.0":{"name":"@mapbox/rehype-highlight-code-block","description":"rehype plugin that finds code blocks in HTML and lets you highlight them","version":"1.0.0","main":"index.js","scripts":{"precommit":"lint-staged","lint":"eslint *.js test lib","format":"prettier --single-quote --write '{,lib/**/,test/**/}*.js'","test-jest":"jest","pretest":"npm run lint","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/mapbox/rehype-highlight-code-block.git"},"keywords":["rehype","rehype-plugin","syntax-highlighting","highlight","html"],"author":{"name":"Mapbox"},"license":"MIT","bugs":{"url":"https://github.com/mapbox/rehype-highlight-code-block/issues"},"homepage":"https://github.com/mapbox/rehype-highlight-code-block#readme","lint-staged":{"{,lib/**/,test/**/}*.js":["eslint","prettier --single-quote --write","git add"]},"jest":{"coverageReporters":["json","lcov","text","html"],"resetMocks":true},"devDependencies":{"dedent":"^0.7.0","eslint":"^4.1.1","eslint-plugin-node":"^5.1.0","husky":"^0.14.1","jest":"^20.0.4","lint-staged":"^4.0.0","prettier":"^1.5.2","rehype":"^5.0.0"},"dependencies":{"hast-util-from-parse5":"^2.0.1","hast-util-to-string":"^1.0.0","parse5":"^3.0.2","unist-util-visit":"^1.1.3"},"gitHead":"a1d5f5f3f50329f9fb72c5072052591351302bac","_id":"@mapbox/rehype-highlight-code-block@1.0.0","_npmVersion":"5.4.1","_nodeVersion":"6.11.1","_npmUser":{"name":"davidtheclark","email":"david.dave.clark@gmail.com"},"dist":{"integrity":"sha512-JdcWEJSwODwZi8mGAknjrRZsA1NBU6Y9br7d/cluVYCpGGcxt7C9xpEJ7p6SP0DL19YeUnCP/qloIK2w3PhBSA==","shasum":"8ae10e0329cf33d6bd709816766ee7ec57df165e","tarball":"https://registry.npmjs.org/@mapbox/rehype-highlight-code-block/-/rehype-highlight-code-block-1.0.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDeb5BwLTPZ7r3tXlbOC4I8L0RZTxZA8aREk2sa8RbzmwIgY/T5aMZnpPhDfUk3Csqse8qe8yIlNQ6lfeajOE+KcGQ="}]},"maintainers":[{"email":"joe.clark@mapbox.com","name":"jc-clark"},{"email":"xianny@gmail.com","name":"xianny"},{"email":"katherine.meng@mapbox.com","name":"katmeng"},{"email":"dave@mapbox.com","name":"dhcole"},{"email":"dave.prukop@mapbox.com","name":"d-prukop"},{"email":"lizzie.gooding@mapbox.com","name":"lizziegooding"},{"email":"mark.misener@mapbox.com","name":"markmisener"},{"email":"nick.italiano@mapbox.com","name":"nickitaliano"},{"email":"tara.adiseshan@gmail.com","name":"taziam"},{"email":"eli.fitch.prof+npm@gmail.com","name":"elifitch"},{"email":"nadia.barbosa@mapbox.com","name":"captainbarbosa-mbx"},{"email":"cameron@mapbox.com","name":"cammace"},{"email":"bruno@mapbox.com","name":"brunoabinader"},{"email":"langston.smith@mapbox.com","name":"langstonsmith"},{"email":"rafa@mapbox.com","name":"geografa"},{"email":"mxn@1ec5.org","name":"1ec5"},{"email":"liz.shigetoshi@mapbox.com","name":"lshig"},{"email":"hello@johnfurrow.com","name":"johnfurrow"},{"email":"andrea.delrio@mapbox.com","name":"aaaandrea"},{"email":"ali@mapbox.com","name":"alianthes"},{"email":"ann.millspaugh@gmail.com","name":"millzpaugh"},{"email":"hello@franka.tech","name":"franka"},{"email":"charlie@mapbox.com","name":"charloyd"},{"email":"julianne@mapbox.com","name":"juliannebg"},{"email":"dthompson@gmail.com","name":"dthompson"},{"email":"eric.alessandrini@mapbox.com","name":"ericdeveloper"},{"email":"jayana.charles@mapbox.com","name":"jayana"},{"email":"christopher.cailleaux@gmail.com","name":"chriscx"},{"email":"poornima@mapbox.com","name":"poornibadrinath"},{"email":"bersabel.tadesse@mapbox.com","name":"brsbl"},{"email":"mallorywood413@gmail.com","name":"mal-wood"},{"email":"luis@mapbox.com","name":"luiswalter"},{"email":"pilar@mapbox.com","name":"piligab"},{"email":"galia@mapbox.com","name":"yurasi"},{"email":"matt.gosline@mapbox.com","name":"matt.gosline"},{"email":"kelly.young@mapbox.com","name":"kellyoung"},{"email":"mully@mapbox.com","name":"zmully"},{"email":"mikel@groundtruth.in","name":"mikelmaron"},{"email":"danpat@danpat.net","name":"danpat"},{"email":"macro.shen@mapbox.com","name":"macro-shen"},{"email":"asheemm@gmail.com","name":"asheemmamoowala"},{"email":"john.sylak-glassman@mapbox.com","name":"jcsg"},{"email":"michael@mapbox.com","name":"michaelsteffen"},{"email":"aj@mapbox.com","name":"ajashton"},{"email":"devin.boyer@mapbox.com","name":"drboyer"},{"email":"andrey@mapbox.com","name":"andygol"},{"email":"flippmoke@gmail.com","name":"flippmoke"},{"email":"safonov.ilya@gmail.com","name":"ilyasaf"},{"email":"denis.koronchik@gmail.com","name":"deniskoronchik"},{"email":"peterqliu@gmail.com","name":"peterqliu"},{"email":"rasagy@mapbox.com","name":"rasagy"},{"email":"chethan@mapbox.com","name":"chetangowda"},{"email":"upendra@mapbox.com","name":"upendrayadav"},{"email":"cesar@mapbox.com","name":"calfarome"},{"email":"pavel@mapbox.com","name":"ridixcr"},{"email":"olivia.brundage@mapbox.com","name":"oliikit"},{"email":"aileen.s.rowan@gmail.com","name":"allierowan"},{"email":"richman@mapbox.com","name":"richrico"},{"email":"danny@mapbox.com","name":"dannykath"},{"email":"eliane@mapbox.com","name":"samely"},{"email":"nikinfour@gmail.com","name":"nikhilprabhakar"},{"email":"gokul.ganesan@mapbox.com","name":"fa7c0n"},{"email":"blannon@gmail.com","name":"boblannon"},{"email":"sean@mapbox.com","name":"sgillies"},{"email":"me@lukasmartinelli.ch","name":"lukasmartinelli"},{"email":"krishna@mapbox.com","name":"nammala"},{"email":"lindsay@mapbox.com","name":"lndsay"},{"email":"vestibule@anandthakker.net","name":"anandthakker"},{"email":"chris.loer@mapbox.com","name":"chrisloer"},{"email":"0o3ko0@gmail.com","name":"kepta"},{"email":"sam.kronick@mapbox.com","name":"kronick"},{"email":"manohar@mapbox.com","name":"manoharuss"},{"email":"alex.parlato@mapbox.com","name":"aparlato"},{"email":"bharata+npm@mapbox.com","name":"bsrinivasa"},{"email":"aarthy@mapbox.com","name":"aarthykc"},{"email":"dane@mapbox.com","name":"springmeyer"},{"email":"dana.sulit@mapbox.com","name":"dasulit"},{"email":"emmanuel.sambale@gmail.com","name":"maning"},{"email":"miles.sackler@mapbox.com","name":"miles-dev"},{"email":"agafonkin@gmail.com","name":"mourner"},{"email":"hello@chau-nguyen.de","name":"chaupow"},{"email":"michael.krasnyk@gmail.com","name":"oxidase"},{"email":"r.ragupathy85@gmail.com","name":"rumc"},{"email":"vincent.sarago@mapbox.com","name":"vincents"},{"email":"tony.chen@mapbox.com","name":"tony-cj"},{"email":"arun.planemad@gmail.com","name":"planemad"},{"email":"patrick@mapbox.com","name":"themarex"},{"email":"laurier@mapbox.com","name":"l-r"},{"email":"alice@mapbox.com","name":"aliceykuo"},{"email":"ansis.brammanis@gmail.com","name":"ansis"},{"email":"oindrila.gupta92@gmail.com","name":"oini"},{"email":"virginia@mapbox.com","name":"virginiayung"},{"email":"karito@mapbox.com","name":"karitotp"},{"email":"srividyabharadwaj26@gmail.com","name":"srividyacb"},{"email":"perry@mapbox.com","name":"perrygeo"},{"email":"colleen.mcginnis@mapbox.com","name":"colleenmcginnis"},{"email":"nat@mapbox.com","name":"natslaughter"},{"email":"nick.cordella@mapbox.com","name":"nickcordella"},{"email":"benjamin@mapbox.com","name":"benjamintd"},{"email":"fischer@mapbox.com","name":"enf"},{"email":"kai@mapbox.com","name":"kaibot3000"},{"email":"paul@mapbox.com","name":"pdgoodman"},{"email":"max@mapbox.com","name":"msirenko"},{"email":"abhishek@mapbox.com","name":"saikia.abhishek"},{"email":"jothirnadh@mapbox.com","name":"jothirnadh"},{"email":"ryan.baumann@mapbox.com","name":"ryan-baumann"},{"email":"dan@mapbox.com","name":"danswick"},{"email":"lily@mapbox.com","name":"lily-chai"},{"email":"amisha@mapbox.com","name":"amishas157"},{"email":"kara.e.mahoney@gmail.com","name":"k-mahoney"},{"email":"bhargav.kowshik@gmail.com","name":"bkowshik"},{"email":"alinapaz@gmail.com","name":"alinapaz"},{"email":"damon@mapbox.com","name":"dnomadb"},{"email":"lyzi@mapbox.com","name":"lyzidiamond"},{"email":"spam@freenerd.de","name":"freenerd"},{"email":"carol@mapbox.com","name":"gretacb"},{"email":"mayaqgao@gmail.com","name":"mayaqgao"},{"email":"camilla@mapbox.com","name":"camillacaros"},{"email":"saman@mapbox.com","name":"samanbb"},{"email":"bryan@mapbox.com","name":"bhousel"},{"email":"daniel+npm@trvx.org","name":"danieljh"},{"email":"decorah@mapbox.com","name":"katydecorah"},{"email":"ajith@mapbox.com","name":"ajithranka"},{"email":"pratik@mapbox.com","name":"pratikyadav"},{"email":"morgan.herlocker@gmail.com","name":"morganherlocker"},{"email":"hi@jacquestardie.org","name":"jacquestardie"},{"email":"mollylloyd@gmail.com","name":"mollymerp"},{"email":"john.firebaugh@gmail.com","name":"jfirebaugh"},{"email":"tim.channell@gmail.com","name":"tcql"},{"email":"ruben@mapbox.com","name":"rub21"},{"email":"mail@kkaefer.com","name":"kkaefer"},{"email":"brendan@mapbox.com","name":"brendanmcfarland"},{"email":"moritz@mapbox.com","name":"mokob"},{"email":"karen@mapbox.com","name":"karenzshea"},{"email":"david.dave.clark@gmail.com","name":"davidtheclark"},{"email":"amyleewalton@gmail.com","name":"amyleew"},{"email":"ian.villeda@gmail.com","name":"ian29"},{"email":"nicki@mapbox.com","name":"nickidlugash"},{"email":"jake@jakepruitt.com","name":"jrpruit1"},{"email":"mcwhittemore@gmail.com","name":"mcwhittemore"},{"email":"siyu.song@gmail.com","name":"isiyu"},{"email":"ghoshkaj@gmail.com","name":"ghoshkaj"},{"email":"ulsh@mapbox.com","name":"alulsh"},{"email":"emily@mapbox.com","name":"emilymcafee"},{"email":"sam@mapbox.com","name":"mapsam"},{"email":"alex@mapbox.com","name":"lxbarth"},{"email":"will@mapbox.com","name":"willwhite"},{"email":"sanjay@mapbox.com","name":"batpad"},{"email":"sajjadkm@gmail.com","name":"geohacker"},{"email":"aruna@mapbox.com","name":"arunasank"},{"email":"kai@mapbox.com","name":"kaidalgleish"},{"email":"matt@mattficke.com","name":"mattficke"},{"email":"andrew@mapbox.com","name":"apendleton"},{"email":"nicholas.ingalls@gmail.com","name":"ingalls"},{"email":"thomas.j.lee@gmail.com","name":"sbma44"},{"email":"dubois@mapbox.com","name":"emilymdubois"},{"email":"young@mapbox.com","name":"yhahn"},{"email":"ian@mapbox.com","name":"ianshward"},{"email":"jeff@miccolis.net","name":"miccolis"},{"email":"ryan.clark.j@gmail.com","name":"rclark"},{"email":"lauren@mapbox.com","name":"lbud"},{"email":"bobby@mapbox.com","name":"bsudekum"},{"email":"tristen.brown@gmail.com","name":"tristen"},{"email":"accounts@mapbox.com","name":"mapbox-admin"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/rehype-highlight-code-block-1.0.0.tgz_1504910616055_0.6187576348893344"},"directories":{}}},"readme":"# @mapbox/rehype-highlight-code-block\n\n[![Build Status](https://travis-ci.org/mapbox/rehype-highlight-code-block.svg?branch=master)](https://travis-ci.org/mapbox/rehype-highlight-code-block)\n\n[rehype] plugin that finds code blocks in HTML and lets you highlight them with a function.\n\n**Best suited for Node**, because it includes an HTML parser, [parse5](https://github.com/inikulin/parse5), to parse the return value of your highlighting function.\nIf you are doing your syntax highlighting in the browser, you might consider [lowlight] or [refractor], both of which will work with [rehype] or other [unified] tools.\n\n## Installation\n\n```\nnpm install @mapbox/rehype-highlight-code-block\n```\n\n## API\n\nFollow the directions for using rehype plugins.\n\n`rehype().use(rehypeHighlightCodeBlock, options)`\n\n### options\n\n#### highlight\n\nType: `(code: string, lang?: string) => ?string`.\n**Required.**\n\nA function that accepts two arguments, `code` and `lang`, and returns a string of HTML representing `code` with syntax highlighting (or a falsy value if you don't want to highlight that block).\n\nEvery time a `pre > code` node is found, its contents are passed to `options.highlight`.\nThe language passed to `options.highlight` with the code is determined by the first `language-` or `lang-` class found on the `code` node.\n\nIf `options.highlight` returns a falsy value, the code block will not be altered.\nIf it returns an HTML string, that string will be parsed and inserted into the AST.\n\n## Usage\n\nUse [as a rehype plugin](https://github.com/wooorm/rehype/blob/master/doc/plugins.md#using-plugins).\n\nSome examples of how you might do that:\n\n```js\nconst rehype = require('rehype');\nconst rehypeHighlightCodeBlock = require('rehype-highlight-code-block');\nconst yourHighlightingFunction = require('../path/to/it');\n\nrehype()\n  .use(rehypeHighlightCodeBlock, {\n    highlight: yourHighlightingFunction\n  })\n  .process(/* some html */);\n```\n\n```js\nconst unified = require('unified');\nconst rehypeParse = require('rehype-parse');\nconst rehypeHighlightCodeBlock = require('rehype-highlight-code-block');\nconst yourHighlightingFunction = require('../path/to/it');\n\nunified()\n  .use(rehypeParse)\n  .use(rehypeHighlightCodeBlock, {\n    highlight: yourHighlightingFunction\n  })\n  .processSync(/* some html */);\n```\n\nIf you'd like to get syntax highlighting in Markdown, parse the Markdown (with remark-parse), convert it to rehype, then use this plugin.\n\n```js\nconst unified = require('unified');\nconst remarkParse = require('remark-parse');\nconst remarkRehype = require('remark-rehype');\nconst rehypeHighlightCodeBlock = require('rehype-highlight-code-block');\nconst yourHighlightingFunction = require('../path/to/it');\n\nunified()\n  .use(remarkParse)\n  .use(remarkRehype)\n  .use(rehypeHighlightCodeBlock, {\n    highlight: yourHighlightingFunction\n  })\n  .process(/* some markdown */);\n```\n\n[rehype]: https://github.com/wooorm/rehype\n[unified]: https://github.com/unifiedjs/unified\n[lowlight]: https://github.com/wooorm/lowlight\n[refractor]: https://github.com/wooorm/refractor\n","maintainers":[{"email":"yannick.meeus+npm+production+ci@mapbox.com","name":"mbx-npm-ci-production"},{"email":"yannick.meeus+npm+staging+ci@mapbox.com","name":"mbx-npm-ci-staging"},{"email":"yannick.meeus+npm+prod+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-production"},{"email":"yannick.meeus+npm+staging+advanced+actions@mapbox.com","name":"mbx-npm-advanced-actions-staging"},{"email":"yannick.meeus+npm+prod+09@mapbox.com","name":"mbx-npm-09-production"},{"email":"yannick.meeus+npm+prod+08@mapbox.com","name":"mbx-npm-08-production"},{"email":"yannick.meeus+npm+prod+07@mapbox.com","name":"mbx-npm-07-production"},{"email":"yannick.meeus+npm+prod+06@mapbox.com","name":"mbx-npm-06-production"},{"email":"yannick.meeus+npm+prod+05@mapbox.com","name":"mbx-npm-05-production"},{"email":"yannick.meeus+npm+prod+04@mapbox.com","name":"mbx-npm-04-production"},{"email":"yannick.meeus+npm+prod+03@mapbox.com","name":"mbx-npm-03-production"},{"email":"yannick.meeus+npm+prod+02@mapbox.com","name":"mbx-npm-02-production"},{"email":"yannick.meeus+npm+prod+01@mapbox.com","name":"mbx-npm-01-production"},{"email":"yannick.meeus@mapbox.com","name":"mbx-npm-02-staging"},{"email":"accounts+npmjs-01@mapbox.com","name":"mapbox-npm-01"},{"email":"accounts+npmjs-02@mapbox.com","name":"mapbox-npm-02"},{"email":"accounts+npmjs-07@mapbox.com","name":"mapbox-npm-07"},{"email":"accounts+npmjs-03@mapbox.com","name":"mapbox-npm-03"},{"email":"accounts+npmjs-04@mapbox.com","name":"mapbox-npm-04"},{"email":"accounts+npmjs-09@mapbox.com","name":"mapbox-npm-09"},{"email":"accounts+npmjs-05@mapbox.com","name":"mapbox-npm-05"},{"email":"accounts+npmjs-06@mapbox.com","name":"mapbox-npm-06"},{"email":"accounts+npmjs-08@mapbox.com","name":"mapbox-npm-08"},{"email":"accounts+npmjs-advanced-actions@mapbox.com","name":"mapbox-npm-advanced-actions"},{"email":"accounts+npmjs-npm-ci@mapbox.com","name":"mapbox-npm-ci"},{"email":"accounts+npmjs@mapbox.com","name":"mapbox-npm"},{"email":"accounts@mapbox.com","name":"mapbox-admin"},{"email":"accounts+npm-mapbox-machine-user@mapbox.com","name":"mapbox-machine-user"}],"time":{"modified":"2023-01-12T12:44:37.044Z","created":"2017-07-05T22:07:45.389Z","0.1.0":"2017-07-05T22:07:45.389Z","1.0.0":"2017-09-08T22:43:36.212Z"},"homepage":"https://github.com/mapbox/rehype-highlight-code-block#readme","keywords":["rehype","rehype-plugin","syntax-highlighting","highlight","html"],"repository":{"type":"git","url":"git+https://github.com/mapbox/rehype-highlight-code-block.git"},"author":{"name":"Mapbox"},"bugs":{"url":"https://github.com/mapbox/rehype-highlight-code-block/issues"},"license":"MIT","readmeFilename":"README.md"}