markdown-it-regex

Plugin for markdown-it, replaces strings that match a regular expression pattern.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-it-regex
0.2.06 years ago7 years agoMinified + gzip package size for markdown-it-regex in KB

Readme

markdown-it-regex
Plugin for markdown-it, replaces strings that match a regular expression pattern.

Installation

yarn add markdown-it-regex

Usage

import markdownIt from 'markdown-it'
import markdownItRegex from 'markdown-it-regex'
const mdi = markdownIt()
mdi.use(markdownItRegex, {
  name: 'emoji',
  regex: /(:(?:heart|panda_face|car):)/,
  replace: (match) => {
    return `<i class="e1a-${match.slice(1, -1)}"></i>`
  }
})
mdi.render('I :heart: you') // <p>I <i class="e1a-heart"></i> you</p>

Development

Build

yarn build:watch

Test

yarn test

Distribution

yarn release && npm publish