blob: 2f01806a34cb7b15bfd611e9ce3f69ba06b77932 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# markdown-escapes [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
List of escapable characters in markdown.
## Installation
[npm][]:
```bash
npm install markdown-escapes
```
## Usage
```javascript
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
flavours.
###### 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).
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[travis-badge]: https://img.shields.io/travis/wooorm/markdown-escapes.svg
[travis]: https://travis-ci.org/wooorm/markdown-escapes
[codecov-badge]: https://img.shields.io/codecov/c/github/wooorm/markdown-escapes.svg
[codecov]: https://codecov.io/github/wooorm/markdown-escapes
[npm]: https://docs.npmjs.com/cli/install
[license]: LICENSE
[author]: http://wooorm.com
|
