Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fannheyward/coc-markdownlint
markdownlint extension for coc.nvim
https://github.com/fannheyward/coc-markdownlint
markdownlint
Last synced: about 4 hours ago
JSON representation
markdownlint extension for coc.nvim
- Host: GitHub
- URL: https://github.com/fannheyward/coc-markdownlint
- Owner: fannheyward
- License: mit
- Created: 2019-10-08T15:40:08.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T07:02:13.000Z (13 days ago)
- Last Synced: 2024-11-06T18:53:06.000Z (7 days ago)
- Topics: markdownlint
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 170
- Watchers: 5
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-markdownlint
[markdownlint](https://github.com/DavidAnson/markdownlint) for Vim/Neovim, works as coc.nvim extension.
## Features
- Style lint
- Autofix
`(coc-codeaction)` on current diagnostic, you will find available codeAction, choose by number to fix.
## Install
`:CocInstall coc-markdownlint`
## Configurations
- `markdownlint.onOpen`: lint on open a file, default `true`
- `markdownlint.onChange`: lint on changing a file, default `true`
- `markdownlint.onSave`: lint on saving a file, default `true`
- `markdownlint.config`: configurations rules used by markdownlint, default `{}`
## Commands
- `markdownlint.fixAll`: fix all errors in current file found by markdownlint
## CodeActions
Provides codeAction for current file or line to disable markdownlint, triggered
by `(coc-codeaction)` and `(coc-codeaction-line)`
- ``
- ``
## Rules
You can configures the markdownlint rules to use, for example:
```json
{
"default": true,
"line_length": false
}
```
`coc-markdownlint` can read configurations from:
1. Global configuration file that [rc](https://www.npmjs.com/package/rc#standards) can find, for example `$HOME/.markdownlintrc`. Checkout `rc` for more examples.
2. `markdownlint.config` section in `coc-settings.json`
3. `.markdownlint.{json, yaml}` in local workspace root
## License
MIT
---
> This extension is created with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)