About this project
Marked is a Markdown parser and compiler designed for speed. It is a low-level compiler that parses Markdown without caching or blocking for long periods, making it suitable for performance-sensitive applications. The library implements all Markdown features from supported flavors and specifications while remaining lightweight.
Key characteristics:
- Built for speed
- Low-level compiler for parsing Markdown without caching or blocking
- Lightweight while implementing all Markdown features from supported flavors and specifications
- Easily adaptable with custom extensions
- Works in a browser, on a server, or from a command line interface (CLI)
Compatibility: Only current and LTS Node.js versions are supported. In browsers, it targets Baseline Widely Available environments.
Installation: Can be installed globally for CLI use via npm, or as a package for in-browser and Node.js usage.
Usage: The library provides a parse function that converts Markdown to HTML. It can be used from the command line, in Node.js, or directly in the browser via UMD or ESM modules. A demo page is available.
Important warning: Marked does not sanitize the output HTML. Users should apply a sanitization library such as DOMPurify, sanitize-html, or insane on the output HTML to prevent XSS attacks.
Documentation covers options and extensibility. The project is MIT licensed.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.