.config/coc/extensions/node_modules/coc-prettier/node_modules/remark/readme.md

   1 # remark [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status] [![Chat][chat-badge]][chat]
   2
   3 The [**remark**][remark] processor is a markdown processor powered by
   4 [plug-ins][plugins].
   5
   6 *   Interface by [**unified**][unified]
   7 *   [**MDAST**][mdast] syntax tree
   8 *   Parses markdown to the tree with [**remark-parse**][parse]
   9 *   [Plug-ins][plugins] transform the tree
  10 *   Compiles the tree to markdown using [**remark-stringify**][stringify]
  11
  12 Don’t need the parser?  Or the compiler?  [That’s OK][unified-usage].
  13
  14 ## Installation
  15
  16 [npm][]:
  17
  18 ```sh
  19 npm install remark
  20 ```
  21
  22 ## Usage
  23
  24 ```js
  25 var remark = require('remark');
  26 var recommended = require('remark-preset-lint-recommended');
  27 var html = require('remark-html');
  28 var report = require('vfile-reporter');
  29
  30 remark()
  31   .use(recommended)
  32   .use(html)
  33   .process('## Hello world!', function (err, file) {
  34     console.error(report(err || file));
  35     console.log(String(file));
  36   });
  37 ```
  38
  39 Yields:
  40
  41 ```txt
  42 1:1  warning  Missing newline character at end of file  final-newline  remark-lint
  43
  44 ⚠ 1 warning
  45 <h2>Hello world!</h2>
  46 ```
  47
  48 ## License
  49
  50 [MIT][license] © [Titus Wormer][author]
  51
  52 <!-- Definitions -->
  53
  54 [build-badge]: https://img.shields.io/travis/wooorm/remark.svg
  55
  56 [build-status]: https://travis-ci.org/wooorm/remark
  57
  58 [coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/remark.svg
  59
  60 [coverage-status]: https://codecov.io/github/wooorm/remark
  61
  62 [chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
  63
  64 [chat]: https://gitter.im/wooorm/remark
  65
  66 [license]: https://github.com/wooorm/remark/blob/master/LICENSE
  67
  68 [author]: http://wooorm.com
  69
  70 [npm]: https://docs.npmjs.com/cli/install
  71
  72 [remark]: https://github.com/wooorm/remark
  73
  74 [unified]: https://github.com/wooorm/unified
  75
  76 [mdast]: https://github.com/wooorm/mdast
  77
  78 [parse]: https://github.com/wooorm/remark/blob/master/packages/remark-parse
  79
  80 [stringify]: https://github.com/wooorm/remark/blob/master/packages/remark-stringify
  81
  82 [plugins]: https://github.com/wooorm/remark/blob/master/doc/plugins.md
  83
  84 [unified-usage]: https://github.com/wooorm/unified#usage