markdown-escapes
List of escapable characters in markdown.
Install
npm:
npm install markdown-escapes
Use
var escapes = require('markdown-escapes');
// Access by property:
escapes.commonmark; //=> ['\\', '`', ..., '@', '^']
// Access by options object:
escapes({gfm: true}); //=> ['\\', '`', ..., '~', '|']
API
escapes([options])
Get escapes. Supports options.commonmark
and options.gfm
, which when true
returns the extra escape characters supported by those flavors.
Returns
Array.<string>
.
escapes.default
List of default escapable characters.
escapes.gfm
List of escapable characters in GFM (which includes all default
s).
escapes.commonmark
List of escapable characters in CommonMark (which includes all gfm
s).