1.0.0 ā€¢ Published 5 years ago

mark-mini v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago
mark-mini
Inline Markdown Parser

Introduction

This is just a convenience package for markdown-it's renderInline(). This is created for using a limited subset of the Markdown syntax for use in comments, contact fields, etc.

Installation

npm install --save mark-mini

Usage

import mark from 'mark-mini'

const html = mark("Hey I'm a [`linked inline code block`](https://nelo.is)!")
// Hey Iā€™m a <a href="https://nelo.is"><code>linked inline code block</code></a>!

Rules enabled

  • _italic_
  • **strong**
  • `code`
  • ~~strikethrough~~
  • [links](#links) with auto-linking

Customizing markdown-it to accommodate your own rules should be easy. šŸ˜‰