2025.2.3 • Published 5 months ago

@davidsneighbour/markdownlint-config v2025.2.3

Weekly downloads
-
License
MIT
Repository
-
Last release
5 months 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

All configurations

2025.0.2

8 months ago

2025.0.1

9 months ago

2024.4.10

11 months ago

2024.4.12

11 months ago

2024.4.11

11 months ago

2025.2.0

5 months ago

2024.4.9

11 months ago

2024.4.8

12 months ago

2025.2.3

5 months ago

2025.2.2

5 months ago

2025.2.1

5 months ago

2025.1.1

8 months ago

2025.1.0

8 months ago

2025.1.5

6 months ago

2025.1.4

6 months ago

2025.1.3

6 months ago

2025.1.2

6 months ago

2024.4.7

12 months ago

2024.4.6

12 months ago

2024.3.49

1 year ago

2024.3.47

1 year ago

2024.3.48

1 year ago

2024.4.5

1 year ago

2024.4.4

1 year ago

2024.4.1

1 year ago

2024.4.0

1 year ago

2024.4.3

1 year ago

2024.4.2

1 year ago

2024.3.46

1 year ago

2024.3.45

1 year ago

2024.3.44

1 year ago

2024.3.43

1 year ago

2024.3.41

1 year ago

2024.3.42

1 year ago

2024.3.40

1 year ago

2024.3.39

1 year ago

2024.3.29

1 year ago

2024.3.20

1 year ago

2024.3.27

1 year ago

2024.3.28

1 year ago

2024.3.25

1 year ago

2024.3.26

1 year ago

2024.3.23

1 year ago

2024.3.24

1 year ago

2024.3.21

1 year ago

2024.3.22

1 year ago

2024.3.30

1 year ago

2024.3.31

1 year ago

2024.3.38

1 year ago

2024.3.37

1 year ago

2024.3.34

1 year ago

2024.3.35

1 year ago

2024.3.32

1 year ago

2024.3.33

1 year ago

2024.3.18

1 year ago

2024.3.19

1 year ago

2024.3.16

1 year ago

2024.3.17

1 year ago

2024.3.14

1 year ago

2024.3.15

1 year ago

2024.3.13

1 year ago

2024.3.12

1 year ago

2024.3.9

1 year ago

2024.3.10

1 year ago

2024.3.11

1 year ago

2024.3.6

2 years ago

2024.3.5

2 years ago

2024.3.4

2 years ago

2024.3.3

2 years ago

2024.3.2

2 years ago

2024.3.1

2 years ago

2024.2.5

2 years ago

2024.2.4

2 years ago

2024.3.0

2 years ago

2024.2.3

2 years ago

2024.2.1

2 years ago

2024.2.0

2 years ago

2024.2.2

2 years ago

2024.1.2

2 years ago

2024.1.1

2 years ago

2024.1.0

2 years ago

2024.0.1

2 years ago

2024.0.3

2 years ago

2024.0.2

2 years ago

5.11.1

2 years ago

5.11.0

2 years ago

5.10.4

2 years ago

5.10.3

2 years ago

5.10.2

2 years ago

5.10.1

2 years ago

5.10.0

2 years ago

5.9.7

2 years ago

5.9.6

2 years ago

5.9.5

2 years ago

5.9.4

2 years ago

5.9.3

2 years ago

5.9.2

2 years ago

5.9.1

2 years ago

5.8.20

2 years ago

5.8.19

2 years ago

5.9.0

2 years ago

5.8.16

2 years ago

5.8.17

2 years ago

5.8.18

2 years ago

5.8.10

2 years ago

5.8.11

2 years ago

5.8.12

2 years ago

5.8.13

2 years ago

5.8.14

2 years ago

5.8.15

2 years ago

5.8.9

2 years ago

5.8.8

2 years ago

5.8.7

2 years ago

5.8.6

2 years ago

5.8.5

2 years ago

5.8.4

2 years ago

5.8.3

2 years ago

5.8.2

2 years ago

5.8.1

2 years ago

5.8.0

2 years ago

5.7.0

2 years ago

5.6.1

2 years ago

5.6.0

2 years ago

5.5.26

2 years ago

5.5.27

2 years ago

5.5.25

2 years ago

5.5.24

2 years ago

5.5.23

2 years ago

5.5.22

2 years ago

5.5.20

2 years ago

5.5.21

2 years ago

5.5.19

2 years ago

5.5.18

2 years ago

5.5.1

2 years ago

5.5.0

2 years ago

5.3.0

2 years ago

5.2.44

2 years ago

5.2.43

2 years ago

5.2.42

2 years ago

5.2.41

2 years ago

5.2.40

2 years ago

5.4.0

2 years ago

5.2.39

2 years ago

5.2.38

2 years ago

5.2.37

2 years ago

5.2.36

2 years ago

5.2.34

2 years ago

5.2.33

2 years ago

5.2.32

2 years ago

5.2.31

2 years ago

5.2.30

2 years ago

5.2.29

2 years ago

5.2.28

2 years ago

5.2.27

2 years ago

5.5.17

2 years ago

5.2.26

2 years ago

5.2.25

2 years ago

5.5.15

2 years ago

5.5.9

2 years ago

5.2.24

2 years ago

5.5.16

2 years ago

5.5.8

2 years ago

5.2.22

2 years ago

5.5.14

2 years ago

5.2.21

2 years ago

5.5.11

2 years ago

5.5.5

2 years ago

5.2.20

2 years ago

5.5.12

2 years ago

5.5.4

2 years ago

5.5.3

2 years ago

5.5.10

2 years ago

5.5.2

2 years ago

5.2.2

2 years ago

5.1.29

2 years ago

5.1.39

2 years ago

5.1.28

2 years ago

5.1.27

2 years ago

5.1.26

2 years ago

5.1.24

2 years ago

5.1.41

2 years ago

5.1.40

2 years ago

5.1.1

3 years ago

5.1.14

3 years ago

5.0.16

3 years ago

5.0.12

3 years ago

5.0.10

3 years ago

5.0.5

3 years ago