.config/coc/extensions/node_modules/coc-prettier/node_modules/markdown-escapes/readme.md

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