{"xo":{"rules":{"unicorn/prefer-includes":"off","unicorn/no-fn-reference-in-iterator":"off","unicorn/prefer-optional-catch-binding":"off"},"esnext":false,"ignores":["remark-html.js"],"prettier":true},"nyc":{"lines":100,"branches":100,"functions":100,"check-coverage":true},"bugs":{"url":"https://github.com/remarkjs/remark-html/issues"},"dist":{"shasum":"de5f052749ff61fc904c9708c155c88a2e2655dc","tarball":"https://registry.npmjs.org/remark-html/-/remark-html-13.0.2.tgz","fileCount":5,"integrity":"sha512-LhSRQ+3RKdBqB/RGesFWkNNfkGqprDUCwjq54SylfFeNyZby5kqOG8Dn/vYsRoM8htab6EWxFXCY6XIZvMoRiQ==","signatures":[{"sig":"MEYCIQC5Sje9cpszMYTIcZeU8+TWbtn5r7pgz7dqVWgLXu5JIgIhAIRPC420mIsmFnp7xZz++Yd50Yyg9BZs0hnF0dTuCxmq","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13017,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhN3aICRA9TVsSAnZWagAATT4P+wR9vsN6SRpH3Zt64T0N\nu/oe1/mRCxkYw5drERhCV805sevZiRvkvR/Kk3ERucfEKinEv3CvsLsyDtm5\nPWQuh/TLyUckExPltMnnJNdtiEYPrXEUAft7wsMPIH87bqEWeNUn85smC8Cv\nSQaZrADs09YDeH1fDWC+o1ka+QfBptteoo/IChHekyy255BmxJI3xg2M0Wp9\njuI0OuPLefx4bSVc6NhYLzYmgpPQoDYkU1UoMOebqPZ+QSCDVvVp2sZ8xawq\nyNPlfQOHxA35kaiIBpn3+G7mvNJRIDyJr+Km+KAdINqOpkXWNJ1TWP00uACj\ntDAGSnhwufCcXYPfKbrDoEka0wonzm812O478anW7J0ShqkEWtOyMcnQzL+5\n/Qi0VArsauTxKBorbeXWIImVDI1x0tlFI3No4+6en9DsQvRu7sODk0iw+i90\nvsjDA24iNMMEkpjXoiByMCFJ1Zm3l1gbNATufnF3Y4GcAKBcJe5mCRYlYE1U\n5ONlXPWYam3L2ePRlXB+pNbmu8zghFX+YTq+VF20NIqMkzNW1yiB5W6ujGfP\nYW6EmJRAGIS8XOyOzeD/L9dcd8YxZK9HjHcgaoKL47+kpFIENydv3B1hHk5V\nj/ewMzSiKQMoB2oYiNlYcgXUmgMap0DrFioBqxCFJXpXaLZPHDhjCv5gL+XU\n4bVD\r\n=dTxs\r\n-----END PGP SIGNATURE-----\r\n"},"name":"remark-html","types":"types/index.d.ts","author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"readme":"# remark-html\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\n[**remark**][remark] plugin to serialize Markdown as HTML.\n\n> ⚠️ This package essentially packs [`remark-rehype`][remark2rehype] and\n> [`rehype-stringify`][rehype-stringify], and although it does support some\n> customisation, it isn’t very pluggable.\n> It’s probably smarter to use `remark-rehype` directly and benefit from the\n> [**rehype**][rehype] ecosystem.\n\n## Note!\n\nThis plugin is ready for the new parser in remark\n([`remarkjs/remark#536`](https://github.com/remarkjs/remark/pull/536)).\nThe current and previous version of the plugin works with the current and\nprevious version of remark.\n\n## Install\n\n[npm][]:\n\n```sh\nnpm install remark-html\n```\n\n## Use\n\nSay we have the following file, `example.md`:\n\n```markdown\n# Hello & World\n\n> A block quote.\n\n* Some _emphasis_, **importance**, and `code`.\n```\n\nAnd our script, `example.js`, looks as follows:\n\n```js\nvar fs = require('fs')\nvar unified = require('unified')\nvar markdown = require('remark-parse')\nvar html = require('remark-html')\n\nunified()\n  .use(markdown)\n  .use(html)\n  .process(fs.readFileSync('example.md'), function (err, file) {\n    if (err) throw err\n    console.log(String(file))\n  })\n```\n\nNow, running `node example` yields:\n\n```html\n<h1>Hello &#x26; World</h1>\n<blockquote>\n<p>A block quote.</p>\n</blockquote>\n<ul>\n<li>Some <em>emphasis</em>, <strong>importance</strong>, and <code>code</code>.</li>\n</ul>\n```\n\n## API\n\n### `remark().use(html[, options])`\n\nSerialize Markdown as HTML.\n\n##### `options`\n\nAll options except for `sanitize` and `handlers` are passed to\n[`hast-util-to-html`][to-html].\n\n###### `options.handlers`\n\nObject mapping [mdast][] [nodes][mdast-node] to functions handling them.\nThis option is passed to [`mdast-util-to-hast`][to-hast-handlers].\n\n###### `options.sanitize`\n\nHow to sanitize the output (`Object` or `boolean`, default: `true`):\n\n*   `false`\n    — HTML is not sanitized, dangerous HTML persists\n*   `true`\n    — HTML is sanitized according to [GitHub’s sanitation rules][github],\n    dangerous HTML is dropped\n*   `Object`\n    — the object is treated as a `schema` for how to sanitize with\n    [`hast-util-sanitize`][sanitize], dangerous HTML is dropped\n\n> Note that raw HTML in Markdown cannot be sanitized, so it’s removed.\n> A schema can still be used to allow certain values from [integrations][]\n> though.\n> To support HTML in Markdown, use [`rehype-raw`][raw].\n\nFor example, to add strict sanitation but allowing `className`s, use something\nlike:\n\n```js\n// ...\nvar merge = require('deepmerge')\nvar github = require('hast-util-sanitize/lib/github')\n\nvar schema = merge(github, {attributes: {'*': ['className']}})\n\nremark()\n  .use(html, {sanitize: schema})\n  .processSync(/* … */)\n```\n\n## Integrations\n\n`remark-html` works great with:\n\n*   [`remark-autolink-headings`](https://github.com/ben-eb/remark-autolink-headings)\n    — Automatically add links to headings in Markdown\n*   [`remark-github`](https://github.com/remarkjs/remark-github)\n    — Generate references to GitHub issues, PRs, users, and more\n*   [`remark-highlight.js`](https://github.com/ben-eb/remark-highlight.js)\n    — Highlight code blocks\n*   [`remark-html-emoji-image`](https://github.com/jackycute/remark-html-emoji-image)\n    — Transform emoji unicodes into html images\n*   [`remark-html-katex`](https://github.com/remark/remark-math/blob/HEAD/packages/remark-html-katex/readme.md)\n    — Transform math to HTML with KaTeX\n*   [`remark-math`](https://github.com/rokt33r/remark-math)\n    — Math support for Markdown (inline and block)\n*   [`remark-midas`](https://github.com/ben-eb/remark-midas)\n    — Highlight CSS code with [midas](https://github.com/ben-eb/midas)\n*   [`remark-toc`](https://github.com/remarkjs/remark-toc)\n    — Generate a Tables of Contents\n*   …and [more][remark-plugins]\n\nAll [**mdast** nodes][mdast] can be compiled to HTML.\nUnknown **mdast** nodes are compiled to `div` nodes if they have `children` or\n`text` nodes if they have `value`.\n\nIn addition, **remark-html** can be told how to compile nodes through\nthree `data` properties ([more information][to-hast]):\n\n*   `hName` — Tag name to compile as\n*   `hChildren` — HTML content to add (instead of `children` and `value`), in\n    [`hast`][hast]\n*   `hProperties` — Map of properties to add\n\nFor example, the following node:\n\n```js\n{\n  type: 'emphasis',\n  data: {\n    hName: 'i',\n    hProperties: {className: 'foo'},\n    hChildren: [{type: 'text', value: 'bar'}]\n  },\n  children: [{type: 'text', value: 'baz'}]\n}\n```\n\n…would yield:\n\n```markdown\n<i class=\"foo\">bar</i>\n```\n\n## Security\n\nUse of `remark-html` is *unsafe* by default and opens you up to a\n[cross-site scripting (XSS)][xss] attack.\nPass `sanitize: true` to prevent attacks.\nSettings `sanitize` to anything else may be unsafe.\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n<!-- Definitions -->\n\n[build-badge]: https://img.shields.io/travis/remarkjs/remark-html/main.svg\n\n[build]: https://travis-ci.org/remarkjs/remark-html\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-html.svg\n\n[coverage]: https://codecov.io/github/remarkjs/remark-html\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-html.svg\n\n[downloads]: https://www.npmjs.com/package/remark-html\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-html.svg\n\n[size]: https://bundlephobia.com/result?p=remark-html\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/HEAD/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/HEAD/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/HEAD/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-plugins]: https://github.com/remarkjs/remark/blob/HEAD/doc/plugins.md#list-of-plugins\n\n[remark2rehype]: https://github.com/remarkjs/remark-rehype\n\n[rehype]: https://github.com/rehypejs/rehype\n\n[rehype-stringify]: https://github.com/rehypejs/rehype/tree/HEAD/packages/rehype-stringify\n\n[raw]: https://github.com/rehypejs/rehype-raw\n\n[mdast]: https://github.com/syntax-tree/mdast\n\n[mdast-node]: https://github.com/syntax-tree/mdast#nodes\n\n[hast]: https://github.com/syntax-tree/hast\n\n[to-html]: https://github.com/syntax-tree/hast-util-to-html\n\n[to-hast-handlers]: https://github.com/syntax-tree/mdast-util-to-hast#optionshandlers\n\n[sanitize]: https://github.com/syntax-tree/hast-util-sanitize\n\n[github]: https://github.com/syntax-tree/hast-util-sanitize#schema\n\n[to-hast]: https://github.com/syntax-tree/mdast-util-to-hast#note\n\n[integrations]: #integrations\n\n[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting\n","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"2133d209ab423ead9c6360ab93850f03a1101d8a","license":"MIT","scripts":{"test":"npm run format && npm run build && npm run test-coverage && npm run test-types","build":"npm run build-bundle && npm run build-mangle","format":"remark . -qfo --ignore-pattern test/ && prettier . --write && xo --fix","test-api":"node test","test-types":"dtslint types","build-bundle":"browserify . -s remarkHtml > remark-html.js","build-mangle":"browserify . -s remarkHtml -p tinyify > remark-html.min.js","test-coverage":"nyc --reporter lcov tape test/index.js"},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"homepage":"https://github.com/remarkjs/remark-html#readme","keywords":["unified","remark","remark-plugin","plugin","mdast","markdown","html","stringify","compile"],"prettier":{"semi":false,"useTabs":false,"tabWidth":2,"singleQuote":true,"trailingComma":"none","bracketSpacing":false},"repository":{"url":"git+https://github.com/remarkjs/remark-html.git","type":"git"},"_npmVersion":"7.21.1","description":"remark plugin to compile Markdown to HTML","directories":{},"maintainers":[{"name":"johno","email":"johnotander@gmail.com"},{"name":"wooorm","email":"tituswormer@gmail.com"}],"_nodeVersion":"16.6.1","contributors":[{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},{"name":"Ben Briggs","email":"beneb.info@gmail.com"},{"name":"Seth Vincent","email":"sethvincent@gmail.com"},{"name":"Junyoung Choi","email":"fluke8259@gmail.com"},{"name":"Jonathan Soeder","email":"jonathan.soeder@gmail.com"}],"dependencies":{"hast-util-to-html":"^7.0.0","hast-util-sanitize":"^3.0.0","mdast-util-to-hast":"^10.0.0"},"remarkConfig":{"plugins":["preset-wooorm"]},"_hasShrinkwrap":false,"readmeFilename":"readme.md","devDependencies":{"xo":"^0.33.0","not":"^0.1.0","nyc":"^15.0.0","tape":"^5.0.0","remark":"^13.0.0-alpha.0","dtslint":"^4.0.0","tinyify":"^3.0.0","unified":"^9.0.0","prettier":"^2.0.0","to-vfile":"^6.0.0","is-hidden":"^1.0.0","browserify":"^16.0.0","remark-cli":"^8.0.0","remark-toc":"^7.0.0","remark-slug":"^6.0.0","rehype-parse":"^7.0.0","remark-github":"^9.0.0","commonmark.json":"^0.29.0","rehype-stringify":"^8.0.0","remark-preset-wooorm":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/remark-html_13.0.2_1631024776222_0.4526975610807671","host":"s3://npm-registry-packages"},"_id":"remark-html@13.0.2","version":"13.0.2"}