markly
v0.2.0
Published
A micro subset of markdown.
Downloads
4
Readme
Markly
A micro subset of Markdown.
Installing
Using npm:
$ npm i markly
Usage
import markly from "markly";
const html = markly("*Hello*");
// html -> "<p><strong>Hello</strong></p>"
Differences with Markdown
- Markly only support paragraphs, non-nested unordered lists, and bold text.
- Markly will always translate line breaks to
<br>
tags. - No support for embedding arbitrary HTML.
These limitations are in place by design and there are no plans for supporting additional features.
Use cases
- Product descriptions
- Chat UIs
- Places where basic formatting of user generated content is needed, without the risk of breaking the UI/layout.