1# markdown-escapes [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov] 2 3List of escapable characters in markdown. 4 5## Installation 6 7[npm][]: 8 9```bash 10npm install markdown-escapes 11``` 12 13## Usage 14 15```javascript 16var escapes = require('markdown-escapes'); 17 18// Access by property: 19escapes.commonmark; //=> ['\\', '`', ..., '@', '^'] 20 21// Access by options object: 22escapes({gfm: true}); //=> ['\\', '`', ..., '~', '|'] 23``` 24 25## API 26 27### `escapes([options])` 28 29Get escapes. Supports `options.commonmark` and `options.gfm`, which 30when `true` returns the extra escape characters supported by those 31flavours. 32 33###### Returns 34 35`Array.<string>`. 36 37### `escapes.default` 38 39List of default escapable characters. 40 41### `escapes.gfm` 42 43List of escapable characters in GFM (which includes all `default`s). 44 45### `escapes.commonmark` 46 47List of escapable characters in CommonMark (which includes all `gfm`s). 48 49## License 50 51[MIT][license] © [Titus Wormer][author] 52 53<!-- Definitions --> 54 55[travis-badge]: https://img.shields.io/travis/wooorm/markdown-escapes.svg 56 57[travis]: https://travis-ci.org/wooorm/markdown-escapes 58 59[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/markdown-escapes.svg 60 61[codecov]: https://codecov.io/github/wooorm/markdown-escapes 62 63[npm]: https://docs.npmjs.com/cli/install 64 65[license]: LICENSE 66 67[author]: http://wooorm.com 68