markdownlint

markdownlint copied to clipboard

I have looked through the issues and discovered some relating to tabs/spaces either 2 or 4 but not a very clear reason why a number is required instead of consistency which seems to be the goal of this standardization.

Ordered lists: 4 is ok Unordered lists: 2 is wanted

Unordered and ordered lists should be identical in tabbing/spacing. I recommend the rule is changed from 2 spaces to consistent spacing (either 2 or 4 - but not both) instead of putting in the rule as 2 and having people disable it with MD007 in a lint file for every directory. Changing this to either a fixed number, or the word "consistent" also brings the benefit of formatting based on the rendering engine used.

CommonMark suggests 4 but not strongly so it seems the discussion decided against requiring 4 instead of 2 in a different issue so I suggest we take this as a consistency and universal measure to either go to "consistent" or "4", which I think "consistent" would be better than requiring all users of unhappy engines to create yaml files in all directories.

MDV requires 4 and Pandoc also likes 4 but will sometimes work with 2 (depending on settings and selected engine). However, many engines will accept 2, but not all. Therefore changing this to consistent as the default and allowing for a fixed number will solve many issues people have regarding format.

Here is a link to the 4v2 ordered list issue: https://github.com/DavidAnson/markdownlint/issues/158