@davidsneighbour/markdownlint-config NPM | npm.io

2024.3.11 • Published 6 days ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

6 days ago

Adds a configuration file for Markdownlint.

Usage with VSCode

Install the VSCode plugin Markdownlint by David Anson. Then add a local configuration file in .markdownlint.json or markdownlint.jsonc:

{
  "extends": "@davidsneighbour/markdownlint-config"
}

The filename, and -format can be any of the ones listed on the markdownlint-cli2 configuration page but my advice is to stay with JSON or JSONC.

Add local rule overrides:

{
  "extends": "@davidsneighbour/markdownlint-config",
  "MD040": false
}

The configuration differs from the default ruleset in the following points:

MD004 (unordered list style) is set to "consistent". That is by preference.
MD013 (line-length) is disabled. I find that today the editor can take care of line flow and having only 80 characters long lines breaks the ease of working with these files.
MD025 (single-title/single-h1) is disabled. The rule should be kept in mind, but every now and then multiple top level headlines are useful.
MD030 (list-marker-space) is disabled. There is no reason to have two spaces after list item markers.
MD041 (first-line-heading/first-line-h1) is disabled. Many README files might start with badges instead of headings.

Usage with CLI (or Lint Staged)

Additional tips for the work with Markdown

Working with VSCode I suggest installing the plugin Markdown All In One by Yu Zhang.

All configurations

markdownlint markdownlint-cli2

@everything-registry/sub-chunk-225 @davidsneighbour/configurations

7 days ago

7 days ago

6 days ago

14 days ago

14 days ago

15 days ago

16 days ago

22 days ago

22 days ago

25 days ago

26 days ago

25 days ago

26 days ago

28 days ago

28 days ago

28 days ago

29 days ago

29 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

10 months ago

10 months ago

6 months ago

6 months ago

10 months ago

6 months ago

6 months ago

10 months ago

6 months ago

10 months ago

6 months ago

7 months ago

10 months ago

6 months ago

7 months ago

7 months ago

6 months ago

7 months ago

11 months ago

12 months ago

11 months ago

12 months ago

12 months ago

12 months ago

1 year ago

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago