smarkdown

Markdown parser, simplicity and extensibility. Fork of marked and marked-ts.

Features

• Awesome: ES6, TypeScript, Rollup, Jest...
• Extensible: Add your own extensions
• Fast: Low-level compiler for parsing markdown without caching or blocking for long periods of time
• Lightweight: It's 10kb of minified and gzipped

Install

yarn add smarkdown
# or 
npm install smarkdown

browser (CDN): jsDelivr | unpkg

Usage

Import the library as a module:

const Smarkdown = require('smarkdown');

Or import the library with a script tag:

<script src="https://cdn.jsdelivr.net/npm/smarkdown/dist/smarkdown.min.js"></script>

Example:

const str = 'I am using **Smarkdown**.';
 
console.log(Smarkdown.parse(str));
// <p>I am using <strong>Smarkdown</strong>.</p>
 
console.log(Smarkdown.parse(str, { nop: true }));
// I am using <strong>Smarkdown</strong>.

More

• Syntax highlighting
• Options
• Extension
• Renderer

Comparison

	Smarkdown	Marked	markdown-it
Version
Minified & Gzipped

License

Anti 996