Markdown to HTML using marked and DOMPurify. Safe by default.
npm install safe-markedConvert Markdown to HTML using marked and DOMPurify.
marked does not sanitized by default.
Also, marked will remove sanitize option in the future.
We want to get safe and easy library that convert Markdown to HTML.
- Convert Markdown to HTML using marked
- Safe by default
- The output is sanitized by DOMPurify
- Type Safe by default
- This library is written by TypeScript
- Work on Browser and Node.js
package size minified gzipped
safe-marked 90.15 KB 39.36 KB 13.82 KB (browser bundle size)
marked@0.7.0 45.05 KB 23.87 KB 7.87 KB
dompurify@1.0.11 45.21 KB 15.3 KB 5.99 KB
# Other Markdown library
markdown-it@9.0.0 325.52 KB 92.69 KB 32.77 KB
showdown@1.9.0 157.28 KB 71.06 KB 23.55 KB
Install with npm:
npm install safe-marked
``js# Header
import { createMarkdown } from "safe-marked";
const markdown = createMarkdown();
const html = markdown(
This is CommonMark text. This is CommonMark text.);`
console.log(html);
/* Header
*/
The output is sanitized by default.
`js
import { createMarkdown } from "safe-marked";
const markdown = createMarkdown();
const html = markdown(
This is XSS));
// sanitized by default
assert.strictEqual(html,
This is XSS
);
`$3
You can pass options for these library.
-
: See marked's options
- onInit(marked: Marked): unknown: You can use onInit to customize marked instance.
- It is useful to add a plugin to marked.
- dompurify: See DOMPurify's optionsAn example for options:
`js
import { createMarkdown } from "safe-marked";
import { gfmHeadingId } from "marked-gfm-heading-id";
const markdown = createMarkdown({
marked: {
// Add plugin to marked
onInit(marked) {
// add plugin
marked.use(gfmHeadingId());
},
// same options for https://marked.js.org/#/USING_ADVANCED.md
gfm: false
},
// same options for https://github.com/cure53/DOMPurify
dompurify: {
ADD_TAGS: ["iframe"]
}
});
const html = markdown(# Header
This is CommonMark text.);
assert.strictEqual(html,
);
`FAQ
$3
No. safe-marked has two type of entry point.
- Node.js
- Browser
Browser entrypoint does not includes jsdom. (just use marked + dompurify)
- Automatically include jsdom? · Issue #5 · azu/safe-marked
Browser demo:
Changelog
See Releases page.
Running tests
Install devDependencies and Run
: npm test
Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
1. Fork it!
2. Create your feature branch:
git checkout -b my-new-feature
3. Commit your changes:
4. Push to the branch: MIT © azu