@billogram/markdown

A Markdown parser and React renderer that supports substitution

Install

yarn add @billogram/markdown

Supported Markdown syntax

A restricted subset (with substitution replacement) is supported.

Strong (bold)

**Apple**

Emphasis (italic)

*Orange*

Strike-through

~~Banana~~

Link

[Pineapple](https://google.com)

[Pineapple](/something)

Link forced new window/tab

Note: non-relative links are always opened in a new window/tab

[Pineapple](blank /something)

Placeholder substitution

Grape %placeholder%

Usage

import markdown from '@billogram/markdown';

Sample usage

markdown('**Hello** ~~world~~');

Result: Hello ~~world~~

markdown('Welcome %name%.', { name: 'James' });

Result: Welcome James.

Note

This library is being published with our use cases in mind and is not necessarily meant to be consumed by the broader public. We probably won't take your feature requests unless they align with our own needs.

License

MIT