3 [![Build][build-badge]][build]
4 [![Coverage][coverage-badge]][coverage]
5 [![Downloads][downloads-badge]][downloads]
6 [![Size][size-badge]][size]
8 List of escapable characters in markdown.
15 npm install markdown-escapes
21 var escapes = require('markdown-escapes');
23 // Access by property:
24 escapes.commonmark; //=> ['\\', '`', ..., '@', '^']
26 // Access by options object:
27 escapes({gfm: true}); //=> ['\\', '`', ..., '~', '|']
32 ### `escapes([options])`
35 Supports `options.commonmark` and `options.gfm`, which when `true` returns the
36 extra escape characters supported by those flavors.
44 List of default escapable characters.
48 List of escapable characters in GFM (which includes all `default`s).
50 ### `escapes.commonmark`
52 List of escapable characters in CommonMark (which includes all `gfm`s).
56 [MIT][license] © [Titus Wormer][author]
60 [build-badge]: https://img.shields.io/travis/wooorm/markdown-escapes.svg
62 [build]: https://travis-ci.org/wooorm/markdown-escapes
64 [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/markdown-escapes.svg
66 [coverage]: https://codecov.io/github/wooorm/markdown-escapes
68 [downloads-badge]: https://img.shields.io/npm/dm/markdown-escapes.svg
70 [downloads]: https://www.npmjs.com/package/markdown-escapes
72 [size-badge]: https://img.shields.io/bundlephobia/minzip/markdown-escapes.svg
74 [size]: https://bundlephobia.com/result?p=markdown-escapes
76 [npm]: https://docs.npmjs.com/cli/install
80 [author]: https://wooorm.com