.config/coc/extensions/node_modules/coc-markdownlint/README.md

   1 # coc-markdownlint
   2
   3 [markdownlint](https://github.com/DavidAnson/markdownlint) for Vim/Neovim, works as coc.nvim extension.
   4
   5 <img width="762" alt="image" src="https://user-images.githubusercontent.com/345274/66472846-abe45880-eac0-11e9-8d0a-6b923fbdbee3.png">
   6
   7 ## Features
   8
   9 - Style lint
  10 - Autofix
  11
  12 `<Plug>(coc-codeaction)` on current diagnostic, you will find available codeAction, choose by number to fix.
  13
  14 ![autofix](https://user-images.githubusercontent.com/345274/66532165-f0afd400-eb40-11e9-99a7-2b30fb03e258.gif)
  15
  16 ## Install
  17
  18 `:CocInstall coc-markdownlint`
  19
  20 ## Configurations
  21
  22 - `markdownlint.onOpen`: lint on open a file, default `true`
  23 - `markdownlint.onChange`: lint on changing a file, default `true`
  24 - `markdownlint.onSave`: lint on saving a file, default `true`
  25 - `markdownlint.config`: configurations rules used by markdownlint, default `{}`
  26
  27 ## Commands
  28
  29 - `markdownlint.fixAll`: fix all errors in current file found by markdownlint
  30
  31 ## CodeActions
  32
  33 Provides codeAction for current file or line to disable markdownlint, triggered
  34 by `<Plug>(coc-codeaction)` and `<Plug>(coc-codeaction-line)`
  35
  36 - `<!-- markdownlint-disable-file -->`
  37 - `<!-- markdownlint-disable-next-line -->`
  38
  39 ## Rules
  40
  41 You can configures the markdownlint rules to use, for example:
  42
  43 ```json
  44 {
  45   "default": true,
  46   "line_length": false
  47 }
  48 ```
  49
  50 `coc-markdownlint` can read configurations from:
  51
  52 1. Global configuration file that [rc](https://www.npmjs.com/package/rc#standards) can find, for example `$HOME/.markdownlintrc`. Checkout `rc` for more examples.
  53 2. `markdownlint.config` section in `coc-settings.json`
  54 3. `.markdownlint.{json, yaml}` in local workspace root
  55
  56 ## License
  57
  58 MIT
  59
  60 ---
  61 > This extension is created by [create-coc-extension](https://github.com/fannheyward/create-coc-extension)