mattmezza / msgdown

*Simple* /messages/, _formatted_.

msgdown

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

Installation

yarn add msgdown

Usage

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:

<strong>Attention:</strong> <em>msgdown</em><sup>TM</sup> is great<sub>1</sub>. <u>Use it</u> or <del>don\'t</del> it is <code>console.log('up to you!')</code>

Custom tokens

By default msgdown will use these tokens:

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:

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

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

Testing

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

Development

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

Author

Matteo Merola [email protected]

msgdown's Issues

Escape token

In some cases we should be able to scape a token, as the default tokens are fairly common chars like '/', so we should be able to make something like '\ /' for it to render '/'.

(fun fact: I had to edit this text because Github has scape the '\ ')

Please replace '¡' defaultToken with a key that an ASCII char on US keyboards

Let me guess ... you live somewhere that has ¡ on the keyboard. Sadly, most other nationalities won't have this character on their keyboard. I'd recommend sticking with standard ASCII chars for markdown which are more universally available.