{"repo":"remarkjs/remark-lint","free":true,"listed":false,"github":"https://github.com/remarkjs/remark-lint","clone":"git clone https://github.com/remarkjs/remark-lint.git","description":"plugins to check (lint) markdown code style","language":"JavaScript","stars":1042,"topics":["remark","remark-lint","markdown","lint","check","style-linter","style","remark-plugin"],"license":"MIT","category":"dev-tools","readme_excerpt":"![remark-lint][file-logo] [![Build][badge-build-image]][badge-build-url] [![Coverage][badge-coverage-image]][badge-coverage-url] [![Downloads][badge-downloads-image]][badge-downloads-url] [![Size][badge-size-image]][badge-size-url] [![Sponsors][badge-sponsors-image]][badge-collective-url] [![Backers][badge-backers-image]][badge-collective-url] [![Chat][badge-chat-image]][badge-chat-url] [remark][github-remark] plugins to check (lint) markdown code style. Contents What is this? When should I use this? Presets Rules Configure Ignore warnings Examples Example: check markdown on the API Example: check and format markdown on the API Example: check markdown on the CLI Example: check and format markdown on the CLI Integrations Syntax Compatibility Security Contribute License What is this? You can use this to check markdown. Say we have a markdown file doc/example.md that contains: Then assuming we installed dependencies and run: We would get a report like this: This GitHub repository is a monorepo that contains ±70 plugins (each a rule that checks one specific thing) and 3 presets (combinations of rules configured to check for certain styles). These packages are build on [unified][github-unified] ([remark][github-remark]). unified is a project that inspects and transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. These lint rules inspect mdast. When should I use this? This project is useful whe","default_branch":null,"files":null,"tree":[],"storefront":"/r/remarkjs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/remarkjs/remark-lint/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}