{"_id":"markdown-wasm","_rev":"5-da7c4212fb201833450c7ef355ec9cb4","name":"markdown-wasm","dist-tags":{"latest":"1.2.0"},"versions":{"1.0.0":{"name":"markdown-wasm","version":"1.0.0","description":"Markdown parser and html generator implemented in WebAssembly","main":"dist/markdown.js","jsnext:main":"dist/markdown.es.js","module":"dist/markdown.es.js","typings":"markdown.d.ts","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"scripts":{"build":"wasmc"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"license":"MIT","devDependencies":{"wasmc":"^2.0.1"},"gitHead":"e75d6b0825557fa2bb5b4d350fd4d3162097d208","bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"_id":"markdown-wasm@1.0.0","_nodeVersion":"13.1.0","_npmVersion":"6.13.2","dist":{"integrity":"sha512-XbI01KYUzWtOry1nydMBo4FjujsKnqgihcX30WU7UkfVqcvD0KMJUEia1fnL9+zEb+o2RO9gfJ3fUSNxqg/yAA==","shasum":"a21415cbf9f2db5dda7225a5a17619de5dbf7f53","tarball":"https://registry.npmjs.org/markdown-wasm/-/markdown-wasm-1.0.0.tgz","fileCount":11,"unpackedSize":163021,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd7cwOCRA9TVsSAnZWagAA5foQAJVyHcYfvi79J/+ppxTl\nYwakBZeBu6Znpqp6PXzsXbB3MVjx05kXlXXBVdVv332JmVugJTOZJ42EEXi5\nP8Gr5G7KkpZysHULMrv0WYpPGfJLNAP+LvZ+XmsDrPGfkge7ZkcMIPJdmiwb\ngaRiq9qXw91kUHntAYO8Ug+S3pr6QJM0uVLWRZxA/RpVQmj5BsRGDFXE71/6\nq75ASuTDNcbFNmnoECC9vqweAf/8zPWyvR10WC9Y/pwM9u/5jxV3Zrae837W\nKcHEj83ANWZjOnquEBq5/bMxgT4yXsikN8jESMzerl/4PezUH3LphRwDCTU0\n3mMjyGHCMj2qPxxAtz6ByNnozcB6U/5J1DNh80wnPM+4bISP6BTmUNMGrHgm\n14ZjNyyQVzY8h5Evto+1HI7XLueh/qLNszRZHa0kiUEl1O5NjUWDi6QvaHTq\ngGHk4b8nqRcU0UirKSxfHH3ZByNYxi3ALxbAgB9VwFmlmaXAOREhPCHlBnNp\n/gTxcfQPGAeAapdP5aSxsNC2W/d1O02GIURgBrNXePtXNbz05D34p6pVLgmz\ntcEMkZbRpET5mQFVOH3K6kwjIw+koS7403kNEYxVHNL+MbMmZrJieoZ05XUY\nyrfQGA86Si1jg6vL7i6X7YjucGY1vvsrHLxoQWe5ANqqpc/m2PPXRcD2hVK/\nz6dL\r\n=7/Ir\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEz7yVzHf9ApFVKbZefI7UrKVn1xv0Y+9eBmdM4/ntqZAiEAzM4DTpzSStTs60CLPusWqsrOZ4r5/FBX8B4CCdXpSB0="}]},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"_npmUser":{"name":"rsms","email":"rasmus@notion.se"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-wasm_1.0.0_1575865357950_0.9086000316290073"},"_hasShrinkwrap":false},"1.1.0":{"name":"markdown-wasm","version":"1.1.0","description":"Markdown parser and html generator implemented in WebAssembly","browser":"dist/markdown.js","main":"dist/markdown.node.js","jsnext:main":"dist/markdown.es.js","module":"dist/markdown.es.js","typings":"markdown.d.ts","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"scripts":{"build":"wasmc","build-debug":"wasmc -g","build-watch":"wasmc -g -w","test":"wasmc -quiet && bash test/test.sh >/dev/null && echo OK","update-web":"cp dist/markdown.js dist/markdown.wasm docs/","print-gzip-size":"echo 'dist/markdown.{js,wasm} gzipped:' $(gzip -9 -c dist/markdown.js dist/markdown.wasm | wc -c | cat) bytes"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"license":"MIT","devDependencies":{"wasmc":"^2.2.0"},"gitHead":"2da75dd2ff5e1b88e13aabac09f26ea889d8134d","bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"_id":"markdown-wasm@1.1.0","_nodeVersion":"14.11.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-rvVhpZrtoMeJ9XJW015AWJKzPVB1mYFgCqirZrvTsXA4l/eo05ljUs4xeCwlVs5YM8tim+WolTGx/bIJwWo5Gw==","shasum":"d2da9802e0dd303006727a85a74671adb3f0167a","tarball":"https://registry.npmjs.org/markdown-wasm/-/markdown-wasm-1.1.0.tgz","fileCount":11,"unpackedSize":157597,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfihyoCRA9TVsSAnZWagAAkFUP/19tUbnEvOiNyfhcX1kx\nn786ZU7f0/l5BGoLt6moZnG0+4CPDrZHTlaFBZyqm1wJhsXUM17v0sm8iI5Y\nU2Yr9dIyjjEXAFDnzQ9TPhW1wLMy35vf17HwcGoJ20zQYpSNRtx97FLjneVx\ntUDRigTsSvg4BqvBDAIxlKIjzJRjGZ+TXlD6pIQauat70nX7Iehs2/F60qTs\nYtyanRYKJDzK2gdy2z2V3NMEeHnryZ4Rfl/wjZ1G8iioyRcGlKa2x2ZUUs9n\nnWkEDkoygnoFXs3X2XhuOjKB9XLQuL8sf3BF8eraFmGInEE6iTp+UujuvdDU\nm5i+MBmNS87cVuFkDDyre3qdjlOv0V+bzK6sKicvAWh6sBQ7eoaIQQHOv3uD\nn6Y9cd5pvccnKE0uM1jobDU9dbM7v6bTg4fAehpjoGAHlO9eHrijoexLHQ/J\n5Rp6GX3BLjE+fysSRWPkXLsAXQ3zXLeu0b9X5J0UBMnTSlWxTPdZ5LQ7gaBD\n2nnCyW/ZuuI9C4N/oDcyEu7pMYh2DsN1T0yKv/aQIQbQV4cYKjnG+1ChpVKm\nVbs6TUgc3DyOqLwY0bAhbb10h4QRKkC9OavR0oMRdPzslG8HlMn2QBf9yHZk\ntIpXX1jfd4AqxZug7TChaCU2Ezx7/HIlZsJlSiR1NQkmEFduTOHutystErat\nyGaL\r\n=sXHt\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCLkGNo7Nq8oiX+X8OAnL0Z3lM0WzkqBqJTApwMHo1dqwIgTbfBzydAqy0lrhF4l1YRAwbLQfHIzG55n5TbdD/vDBQ="}]},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"_npmUser":{"name":"rsms","email":"rasmus@notion.se"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-wasm_1.1.0_1602886824147_0.2911357913862702"},"_hasShrinkwrap":false},"1.1.1":{"name":"markdown-wasm","version":"1.1.1","description":"Markdown parser and html generator implemented in WebAssembly","browser":"dist/markdown.js","main":"dist/markdown.node.js","jsnext:main":"dist/markdown.es.js","module":"dist/markdown.es.js","typings":"markdown.d.ts","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"scripts":{"build":"wasmc","build-debug":"wasmc -g","build-watch":"wasmc -g -w","test":"wasmc -quiet && bash test/test.sh >/dev/null && echo OK","update-web":"cp dist/markdown.js dist/markdown.wasm docs/","print-gzip-size":"echo 'dist/markdown.{js,wasm} gzipped:' $(gzip -9 -c dist/markdown.js dist/markdown.wasm | wc -c | cat) bytes"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"license":"MIT","devDependencies":{"wasmc":"^2.2.0"},"gitHead":"cb877fce882728fe513599fcd93d8406ea9ab0e7","bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"_id":"markdown-wasm@1.1.1","_nodeVersion":"14.11.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-rpSgLf4jjGLn1vJ8h5P30G8bOw1VFu52f8KSvzhctwiCgy4ZqkbRbLYmE7Lgb1A7ecxEgsLtc1Hlx3VkWX2dJA==","shasum":"32b010798fafa6aed87b9e2dd8ec7ad11a7b507a","tarball":"https://registry.npmjs.org/markdown-wasm/-/markdown-wasm-1.1.1.tgz","fileCount":11,"unpackedSize":157726,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfiiatCRA9TVsSAnZWagAA64UP/Av8kwWolsBczrWhOSYT\n/DA8Z3PpOoqNYAJjG34mZZQf4EGkk8pQ08khxxSbqyO7PfmW4CYPJvypcGVi\nSe9lVklvQ9jh6TTjlKcvyAyh5+vQnHnKGhchQLvqmJYt5BmM9NhPs57MIxTG\nJTXUQd6ulE9WYHtQOoH0hK7GkNLIz4dnfT8uCwlgvsf1xQ8WPpvIn+VpD7ke\ncMyUFOX2F4Uh0J+aMM+1TopPdEnV7z5V9R4uCr/muOMevDq6p8FeK48j/he8\nlJj6BtSUfiqLGwmuJstee4L29YAHfvFkkbGk4R13k0rqJU3/PTJbi2GHJsn6\nTJU3S5bVqMKptI7CeKgAtFfl7plxrHMnjFkIUiyB+BJlKR3SKPH5wklC6LZW\ndDSCUsbKDJH0FXEFmQuCZhJojjZJ5h2KYUZ3WZbT/4ORkr0uN7lVSeIoHK2R\nHjdm9UE7y2l5FEsrL2KK0WsDmYNrCQeJv5q/WRcp58fpMTsOJLrbHN3eyvnv\n6I2rXQhNBjW4DOEmv8Im2aUgD+iJY88WKqhWFLA7Ubh0D/tHF6iEG1RF9CVk\nUdffnFLg05BRcJn2ExNVPP0/6W3LZoU3FvcAI4r1YNGVVS84Tr6cdRxV3bGA\nw9FzCezQki3VAiFJo/Hpm7/9mhcKfTECdP1QA75heX1Y+sC105efV/DlmZ5Q\nYD90\r\n=3ZOa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDByB7LtXJx5OVI85eEQfLO/QzBdkq2xUi0AmUkZW4njgIgPGgnxpSINz026pK2Wx8RgcxNbdI1VQzBIlhRDeje0NY="}]},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"_npmUser":{"name":"rsms","email":"rasmus@notion.se"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-wasm_1.1.1_1602889389174_0.5973475267313282"},"_hasShrinkwrap":false},"1.1.2":{"name":"markdown-wasm","version":"1.1.2","description":"Markdown parser and html generator implemented in WebAssembly","browser":"dist/markdown.js","main":"dist/markdown.node.js","jsnext:main":"dist/markdown.es.js","module":"dist/markdown.es.js","typings":"markdown.d.ts","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"scripts":{"build":"wasmc","build-debug":"wasmc -g","build-watch":"wasmc -g -w","test":"wasmc -quiet && bash test/test.sh >/dev/null && echo OK","update-web":"cp dist/markdown.js dist/markdown.wasm docs/","print-gzip-size":"echo 'dist/markdown.{js,wasm} gzipped:' $(gzip -9 -c dist/markdown.js dist/markdown.wasm | wc -c | cat) bytes"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"license":"MIT","devDependencies":{"wasmc":"^2.2.0"},"gitHead":"b290af55e1c365690a1934e4a15f8d4ecd6e1c79","bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"_id":"markdown-wasm@1.1.2","_nodeVersion":"14.11.0","_npmVersion":"6.14.8","dist":{"integrity":"sha512-tlepP32bgDetkRxx/neVKvEroQ8bR1PoSKvdrTOE+9j05Uoe9Lq+86E8PAciWQ2xr1EWKueNYMkQOmcPT7EwIg==","shasum":"d7055b7358884f8f30b286dea600cf2a807b5cc1","tarball":"https://registry.npmjs.org/markdown-wasm/-/markdown-wasm-1.1.2.tgz","fileCount":11,"unpackedSize":155825,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfjIeVCRA9TVsSAnZWagAAHggP/17QhANjFEV+u8wtwS8U\ntq3IpD9erSwKI+emodkzaXWe5Y/MjyRaoxyfmBlgPCsP02smIuIeAXWLIkRE\nD9KMzvG0BUM80NvhO0OyPgdUU/W+dnXFA6K3MLeY+SGPFWccbWgZ0RyjK7aU\nCpn2mDCxoSETl/8XgJgwNQ/pBNszI4F9zsYG+D2UeU3l92Lv1B3mA+jLBGUS\n0a78UHclZ58Ewk75RkQbDQIfciUt6p3I8jBjylvVYyT0zXCO5t1Sj+S/V0IQ\n70SKgETFxWkIVn6rMVqvjZTIzSfjYxXOipWuxMNAJ5Nlao+pVZINngjcJf6f\nzy1MCugsJQqUP1gqIfUfWizsit+lgyDgcTU4qy2jIqel0xJh2ewr7jI6F7XX\nG2wNDavVrSbcMBCFSO6qpuWZElqo+r+cD34EUStKoS/55HcxW3AZjQl2XJ39\nx5PDcwVwati8U8fDaHXclyL+rKu/2IUfWbwjLfmI9E8yp9fTxTgGXETRRZSd\n39o0ulB5IiYV8A3EjcL4m6KSmUEdeYWQpr0IbQukrRq/J9H4LP0XjHoUnM2z\nfD9PweUdAidEaBVVkQZZmnF+Po696CWHNW96wkxQGMaIPJTa1sKFUjcp1Yms\nLFrcHASRytB2KX67IGwdVYNsni1LL1oLCRssjokQKqEogUP+1LpuP/EvHrnA\n5tdu\r\n=I4NG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE/TF4jdfR8GdzEoFhV4MbOz2WGYhHWxbNFR+xEw7WY/AiBCIcjevZiQIG2Ey6KZq/P6LLDLLajL1rKvc1zN62T4NQ=="}]},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"_npmUser":{"name":"rsms","email":"rasmus@notion.se"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-wasm_1.1.2_1603045269416_0.20080268107150756"},"_hasShrinkwrap":false},"1.2.0":{"name":"markdown-wasm","version":"1.2.0","description":"Markdown parser and html generator implemented in WebAssembly","browser":"dist/markdown.js","main":"dist/markdown.node.js","jsnext:main":"dist/markdown.es.js","module":"dist/markdown.es.js","typings":"markdown.d.ts","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"scripts":{"build":"wasmc","build-debug":"wasmc -g","build-watch":"wasmc -g -w","test":"wasmc -quiet && bash test/test.sh >/dev/null && echo OK","update-web":"cp dist/markdown.js dist/markdown.wasm docs/","print-gzip-size":"echo 'dist/markdown.{js,wasm} gzipped:' $(gzip -9 -c dist/markdown.js dist/markdown.wasm | wc -c | cat) bytes"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"license":"MIT","devDependencies":{"wasmc":"^2.2.1"},"gitHead":"0aa6c8ff6c717859599b32fb203166c1d73d838e","bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"_id":"markdown-wasm@1.2.0","_nodeVersion":"16.1.0","_npmVersion":"7.11.2","dist":{"integrity":"sha512-S12OTkyXCkOgI1n1rZY9cg4bK/PGu80Emjpvwp8BEjwCxhPV3yddF0U6+QhCitdBsI1tzWcoeahmW7k0Pq81OA==","shasum":"403204100fda293b58075d38b498e73bc109357a","tarball":"https://registry.npmjs.org/markdown-wasm/-/markdown-wasm-1.2.0.tgz","fileCount":11,"unpackedSize":165140,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg3TBrCRA9TVsSAnZWagAAIZYP/iWvi68a2hvh3NUWEjqV\nMPbYuwkcNRz2BSvBgSDa/B6R9LSufOl6EQ45wJjlpgMR8ZaPUYOdJ7ggNCp1\nOh/Qo5iY+jgwML2pOzd7+U6GM0/5ny+9SddUDQP7k/cCK8ZbTwnpAN/O+CrU\n0cNjiliN++YYaOKwSn3fd8xwXlZajeXZG47g85LmQXao4dmMvXKWtuPvaGqh\nY7Qb6R5nORk7bRD507Db7zmuVx+5Gh6CWOEP623o0nDrp5r5QzUOP40mWhKi\n7jSUcIj2XWOu23J0bqOWrwf3jCAk2gSHHoejryYAiMfxuHs96nfH05LoCQ4E\naAFhKGyCw846UNiZINGrj1jAmIOksMzmhWjbv5trlisLYeeWFJj1p1GwQNQM\nsTgt9Y9nV4bpbiAiBBxcvAQO4p0+USXuub/T41CiVR6RkYdGU7nlpHGBlSH3\ns5OyoAROMek8KRhZ6C6sAffzLQOYxeJIeR5iLbnQ4SyWQm/1+pSARdLYnrXs\nllIhQwmkv6ySZJfxcdTR1LNW2EUFjfhEk69HlwBUuUhoZOXFLRSDABCCUHaU\nzXu+fuHyyo9p2+NkI0k0DIl6CxjDAmdy4a1mNvUxLYCkiDyyBgjWixqdsqn6\nkcUlSLImFYvD//DjExTAQ2H3eyBeoOzcxS+lkUZNMKL1qnDOXapnPJsOOj0b\nK/ZS\r\n=K2Ih\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICPrRfGlZIjnX1TE3vnkFccn2j6ebesucIfm8OM5gsiiAiEA1iwEIcZ5zgxEjxzROZTuzQgv/zE/ReLr+ggAKNyVhiE="}]},"_npmUser":{"name":"rsms","email":"rasmus@notion.se"},"directories":{},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-wasm_1.2.0_1625108587007_0.6915252804427268"},"_hasShrinkwrap":false}},"time":{"created":"2019-12-09T04:22:37.950Z","1.0.0":"2019-12-09T04:22:38.083Z","modified":"2022-05-08T20:37:21.135Z","1.1.0":"2020-10-16T22:20:24.462Z","1.1.1":"2020-10-16T23:03:09.344Z","1.1.2":"2020-10-18T18:21:09.595Z","1.2.0":"2021-07-01T03:03:07.254Z"},"maintainers":[{"name":"rsms","email":"rasmus@notion.se"}],"description":"Markdown parser and html generator implemented in WebAssembly","homepage":"https://github.com/rsms/markdown-wasm","repository":{"type":"git","url":"git+https://github.com/rsms/markdown-wasm.git"},"author":{"name":"Rasmus Andersson","email":"https://rsms.me/"},"bugs":{"url":"https://github.com/rsms/markdown-wasm/issues"},"license":"MIT","readme":"# markdown-wasm\n\nVery fast Markdown parser & HTML renderer implemented in WebAssembly\n\n- Zero dependencies (31 kB gzipped)\n- Portable & safe (WASM executes in isolated memory and can run almost anywhere)\n- [Simple API](#api)\n- [Very fast](#benchmarks)\n- Based on [md4c](http://github.com/mity/md4c) — compliant to the CommonMark specification\n\n\n## Examples\n\nIn NodeJS, single file with embedded compressed WASM\n\n```js\nconst markdown = require(\"./dist/markdown.node.js\")\nconsole.log(markdown.parse(\"# hello\\n*world*\"))\n```\n\nES module with WASM loaded separately\n\n```js\nimport * as markdown from \"./dist/markdown.es.js\"\nawait markdown.ready\nconsole.log(markdown.parse(\"# hello\\n*world*\"))\n```\n\nWeb browser\n\n```html\n\n\n```\n\n\n## Install\n\n```\nnpm install markdown-wasm\n```\n\n\n\n## Benchmarks\n\nThe [`test/benchmark`](test/benchmark) directory contain a benchmark suite which you can\nrun yourself. It tests a few popular markdown parser-renderers by parsing & rendering a bunch\nof different sample markdown files.\n\nThe following results were samples on a 2.9 GHz MacBook running macOS 10.15, NodeJS v14.11.0\n\n\n#### Average ops/second\n\nOps/second represents how many times a library is able to parse markdown and render HTML\nduring a second, on average across all sample files.\n\n\n\n\n#### Average throughput\n\nThroughput is the average amount of markdown data processed during a second while both parsing\nand rendering to HTML. The statistics does not include HTML generated but only bytes of markdown\nsource text parsed.\n\n\n\n\n#### Min–max parse time\n\nThis graph shows the spread between the fastest and slowest parse-and-render operations\nfor each library. Lower numbers are better.\n\n\n\nSee [`test/benchmark`](test/benchmark#readme) for more information.\n\n\n## API\n\n```ts\n/**\n * parse reads markdown source at s and converts it to HTML.\n * When output is a byte array, it will be a reference.\n */\nexport function parse(s :Source, o? :ParseOptions & { asMemoryView? :never|false }) :string\nexport function parse(s :Source, o? :ParseOptions & { asMemoryView :true }) :Uint8Array\n\n/** Markdown source code can be provided as a JavaScript string or UTF8 encoded data */\ntype Source = string|ArrayLike\n\n/** Options for the parse function */\nexport interface ParseOptions {\n /**\n * Customize parsing.\n * If not provided, the following flags are used, equating to github-style parsing:\n * COLLAPSE_WHITESPACE\n * PERMISSIVE_ATX_HEADERS\n * PERMISSIVE_URL_AUTO_LINKS\n * STRIKETHROUGH\n * TABLES\n * TASK_LISTS\n */\n parseFlags? :ParseFlags\n\n /**\n * asMemoryView=true causes parse() to return a view of heap memory as a Uint8Array,\n * instead of a string.\n *\n * The returned Uint8Array is only valid until the next call to parse().\n * If you need to keep the returned data around, call Uint8Array.slice() to make a copy,\n * as each call to parse() uses the same underlying memory.\n *\n * This only provides a performance benefit when you never need to convert the output\n * to a string. In most cases you're better off leaving this unset or false.\n */\n asMemoryView? :boolean\n}\n\n/** Flags that customize Markdown parsing */\nexport enum ParseFlags {\n /** In TEXT, collapse non-trivial whitespace into single ' ' */ COLLAPSE_WHITESPACE,\n /** Enable $ and $$ containing LaTeX equations. */ LATEX_MATH_SPANS,\n /** Disable raw HTML blocks. */ NO_HTML_BLOCKS,\n /** Disable raw HTML (inline). */ NO_HTML_SPANS,\n /** Disable indented code blocks. (Only fenced code works.) */ NO_INDENTED_CODE_BLOCKS,\n /** Do not require space in ATX headers ( ###header ) */ PERMISSIVE_ATX_HEADERS,\n /** Recognize e-mails as links even without <...> */ PERMISSIVE_EMAIL_AUTO_LINKS,\n /** Recognize URLs as links even without <...> */ PERMISSIVE_URL_AUTO_LINKS,\n /** Enable WWW autolinks (without proto; just 'www.') */ PERMISSIVE_WWW_AUTOLINKS,\n /** Enable strikethrough extension. */ STRIKETHROUGH,\n /** Enable tables extension. */ TABLES,\n /** Enable task list extension. */ TASK_LISTS,\n /** Enable wiki links extension. */ WIKI_LINKS,\n\n /** Default flags */ DEFAULT,\n /** Shorthand for NO_HTML_BLOCKS | NO_HTML_SPANS */ NO_HTML,\n}\n```\n\nSee `markdown.d.ts`\n\n\n## Building from source\n\n```\nnpm install\nnpx wasmc\n```\n\nBuild debug version of markdown into ./build/debug and watch source files:\n\n```\nnpx wasmc -g -w\n```\n\nIf you need special builds, like for example an ES module with embedded WASM,\nedit the `wasmc.js` file and add `module({...})` directives.\n\nExample:\n\n```js\nmodule({ ...m,\n name: \"markdown-custom\",\n out: outdir + \"/markdown.custom.js\",\n embed: true,\n format: \"es\",\n})\n```\n","readmeFilename":"README.md"}