msgdown

msgdown
======

A simple message formatter for bold, strikethrough, underline, sub, sup, italic and code.

!msgdown

!logo

$3

yarn add msgdown

$3

``js
const down = require('msgdown')

const msg = Attention: /msgdown/^TM^ is great¡1¡. _Use it_ or ~don\'t~ it is \console.log('up to you!')\
const html = down(msg)
`

html will contain exactly this:

`html
Attention: msgdownTM is great1. Use it or don\'t it is console.log('up to you!')
`

#### Custom tokens

By default msgdown will use these tokens:

`js
const defaultTokens = {
bold: {delimiter: '*', tag: 'strong'},
italic: {delimiter: '/', tag: 'em'},
underline: {delimiter: '_', tag: 'u'},
strike: {delimiter: '~', tag: 'del'},
code: {delimiter: '', tag: 'code'},
sup: {delimiter: '^', tag: 'sup'},
sub: {delimiter: '¡', tag: 'sub'}
}
``

You can override every and each of the tokens by passing in your custom token object on every function call:

`js
const html = down('ßI am bold with a bß', {bold: {delmiter: 'ß', tag: 'b'}})
`

The above html will contain I am bold with a b.

$3

There is a test file linked to yarn test`. Should be enough even though enough is never enough.

$3

Maybe add more tokens? Maybe add pattern matching instead of plain one char matching? Maybe something else? You name it...

$3

Matteo Merola