{"_id":"@darkguy10/discord-markdown","_rev":"1-b58c997ee858810e8c43da49c0a9e42d","name":"@darkguy10/discord-markdown","dist-tags":{"latest":"2.6.0"},"versions":{"2.6.0":{"name":"@darkguy10/discord-markdown","version":"2.6.0","description":"A markdown parser for Discord messages","keywords":["discord","markdown","parser","md"],"main":"index.js","types":"index.d.ts","repository":{"type":"git","url":"git+https://github.com/darkguy10/discord-markdown.git"},"author":{"name":"Brussell","url":"https://brussell.me"},"contributors":[{"name":"Sorunome"},{"name":"DarkGuy10"}],"license":"MIT","private":false,"scripts":{"test":"jest --verbose","lint":"eslint .","dist":"rollup -c","prepublishOnly":"npm run dist"},"dependencies":{"highlight.js":"^11.2.0","simple-markdown":"^0.7.3"},"devDependencies":{"eslint":"^7.32.0","jest":"^25.1.0","rollup":"^1.32.1","rollup-plugin-commonjs":"^10.1.0","rollup-plugin-node-resolve":"^5.2.0","rollup-plugin-replace":"^2.2.0","rollup-plugin-terser":"^5.3.0"},"gitHead":"8d0ec3e640f9e1a1e8155bbc4d71fa6686e360c3","bugs":{"url":"https://github.com/darkguy10/discord-markdown/issues"},"homepage":"https://github.com/darkguy10/discord-markdown#readme","_id":"@darkguy10/discord-markdown@2.6.0","_nodeVersion":"17.3.0","_npmVersion":"8.4.0","dist":{"integrity":"sha512-VhbgBQyb1GhUHAPCy3Avf2VPZLmxKrVtOM5Rp4lmc+atvOd4COcPKw2AmTs3wf/7GHdjGXPxaVhikbnGTViZjA==","shasum":"2b00409119e44adfcfb5b4180d8110276b0eb020","tarball":"https://registry.npmjs.org/@darkguy10/discord-markdown/-/discord-markdown-2.6.0.tgz","fileCount":15,"unpackedSize":943865,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiJu4nACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpP5A/8DnOP0iNkFSUHZuT0OQh9BQP6gVG7+ZR2cPgp3y7IdF2odPzR\r\nvVI/FY0TPCKppRCkgRBYr1Q0ENepHm8neIIs6z11x1fnGRItaKpCa+M5ekvM\r\n9NPjVuzPDRvtQTZcu+nssWgUtqnnDVw0TNSIt3BlnWZZDTMaQTNwoqLQQwk/\r\naY3l5ogdhVuMrd2tYS8Ng0MZjOdIw27qdn3XCLeFu3uRinHiWyh7W9WW/Nfh\r\nBPN6HTBZ2qUakcYFND/66MMYHd0wwi3VTRCceKVl1hQx1xlX89ey7JkNhWKF\r\nXPCioFaHiYBW484ZMxpRcKCWO3i5HtTlLWNWMoxblzjei3cgPPc1zGaQMBrQ\r\nIIM3+5YsBciB8VxWtcY35jyuA0Y01Dni/CZVgelzVytwML4zWZUV2FWQ/CpD\r\nbzxeXJzEEClONJLSQE6PZCZnEcE2+ZKBbTTPd+/r8TvcUOyFtKhrRnupcJgN\r\nURxB3yNtCSAttIvnXjCGNke93Z6JxeuhUyVDPwW07jyJX/Rex0XvSsUCBIMd\r\nN6NF8fAxmDvR/SfovaKIZCSBXdvM4tb3LqCwMr6ocSU3t9fmscue5jTjtgHZ\r\n88GCtDM6zbneG3wdfkQbCA++HhUE2mFVSy3QsIH2KmDQDtSmMMWa3wuf7xHv\r\ngyrhxwXUgLB+B1F9YqjsaXWeYneeyHSIQwo=\r\n=nM4i\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDgQmdrIYQnh4j9okD/kC5h+KNIY4xX+01sSxArhyUbXAiAnfKgFrnVMIZWwgV/nUVh2tzysExlKCGcgy6kSkxHBLg=="}]},"_npmUser":{"name":"darkguy10","email":"HarperBurn@protonmail.ch"},"directories":{},"maintainers":[{"name":"darkguy10","email":"HarperBurn@protonmail.ch"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/discord-markdown_2.6.0_1646718503643_0.8194721505329228"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-08T05:48:23.568Z","2.6.0":"2022-03-08T05:48:23.863Z","modified":"2022-04-05T02:45:09.931Z"},"maintainers":[{"name":"darkguy10","email":"HarperBurn@protonmail.ch"}],"description":"A markdown parser for Discord messages","homepage":"https://github.com/darkguy10/discord-markdown#readme","keywords":["discord","markdown","parser","md"],"repository":{"type":"git","url":"git+https://github.com/darkguy10/discord-markdown.git"},"contributors":[{"name":"Sorunome"},{"name":"DarkGuy10"}],"author":{"name":"Brussell","url":"https://brussell.me"},"bugs":{"url":"https://github.com/darkguy10/discord-markdown/issues"},"license":"MIT","readme":"# discord-markdown\n\nA markdown parser for Discord messages.\n\n##### Forked from [brussell98/discord-markdown](https://github.com/brussell98/discord-markdown)\n\n## Using\n\n```bash\nyarn add discord-markdown\nnpm i discord-markdown\n```\n\nFor browser use, import `dist/discord-markdown.min.js`\n\n```js\nconst { parser, htmlOutput, toHTML } = require(\"discord-markdown\");\n\nconsole.log(toHTML(\"This **is** a __test__\"));\n// => This <strong>is</strong> a <u>test</u>\n```\n\nFenced codeblocks will include highlight.js tags and classes.\n\n## Options\n\n```js\nconst { toHTML } = require(\"discord-markdown\");\ntoHTML(\"This **is** a __test__\", options);\n```\n\n`options` is an object with the following properties (all are optional):\n\n-   `embed`: Boolean (default: false), if it should parse embed contents (rules are slightly different)\n-   `escapeHTML`: Boolean (default: true), if it should escape HTML\n-   `discordOnly`: Boolean (default: false), if it should only parse the discord-specific stuff\n-   `discordCallback`: Object, callbacks used for discord parsing. Each receive an object with different properties, and are expected to return an HTML escaped string\n    -   `user`: (`id`: Number) User mentions \"@someperson\"\n    -   `channel`: (`id`: Number) Channel mentions \"#somechannel\"\n    -   `role`: (`id`: Number) Role mentions \"@somerole\"\n    -   `everyone`: () Everyone mention \"@everyone\"\n    -   `here`: () Here mention \"@here\"\n-   `cssModuleNames`: Object, maps CSS class names to CSS module class names\n\n### Mention and Emoji Handling\n\nUsing the `discordCallback` option you can define custom functions to handle parsing mention and emoji content. You can use these to turn IDs into names.\n\nExample:\n\n```js\nconst { toHTML } = require('discord-markdown');\ntoHTML('This is a mention for <@95286900801146880>', {\n\tdiscordCallback: {\n\t\tuser: node => '@' + users[node.id];\n\t}\n}); // -> This is a mention for @Brussell\n```\n\n## Customizing\n\nIt is possible to change the rules used by discord-markdown. Take a look at the code to see how to create your own modified rule set.\n\n## Contributing\n\nFind an inconsistency? File an issue or submit a pull request with the fix and updated test(s).\n","readmeFilename":"README.md"}