Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

AtomLinter/linter-markdown

Folders and files

NameName
Last commit message
Last commit date
Feb 12, 2019
Aug 29, 2015
Sep 17, 2019
Apr 14, 2017
Dec 29, 2015
Feb 15, 2016
Apr 26, 2018
Apr 14, 2017
Apr 26, 2018
Dec 18, 2019
Dec 11, 2015
Aug 2, 2017
Sep 17, 2019
Feb 17, 2020
Feb 17, 2020

Repository files navigation

linter-markdown

Build Status Circle CI Build status

bitHound Overalll Score bitHound Dependencies Plugin installs! Package version!

Lint markdown files using remark-lint and the linter package for atom.

If there is no configuration found for remark-lint, this linter runs remark-preset-lint-consistent and remark-preset-lint-recommended (both can be turned off). You can a also turn on remark-preset-lint-markdown-style-guide. By default, YAML frontmatter is supported, but you can turn that off.

If there is configuration for remark-lint, through .remarkrc files or remarkConfig in package.jsons, this linter works just like remark-cli.

You should probably install modules referenced in .remarkrc files locally (npm install without the -g or --global flag). If you do install modules globally, you must either use nvm, or have a prefix in your .npmrc.

See this tutorial on how to set-up npm to work without sudo, which is good practise, and comes with the added benefit that linter-markdown can pick up on globally installed modules.

Read more about configuring remark-lint on its README.

A similar linter, linter-remark, runs all remark plugins, but only when they are configured to run.

We also maintain a changelog containing recent changes.

Screenshot of linter-markdown in action