Incompatibilities with some markdownlint rules

[rekmarks]

This package produces CHANGELOG.md files that are incompatible with markdownlint.

The written changelog conforms exactly to the example from the Keep a Changelog website, but are its spacing conventions really relevant to the spec our our ability to parse a changelog?

I believe that the spacing is irrelevant to the Keep a Changelog spec, and we should make the output changelogs compatible with markdownlint at least in terms of spacing. There may even be an argument to integrate markdownlint into this tool, but that's a different question.

Related: #50. markdownlint-compatibility appears to be largely equivalent with Prettier-compatibility.

[Gudahtt]

It is not incompatible - it just doesn't conform exactly to the default ruleset. It seems to work fine if you adjust the blanks-around-headers rule to no longer require any lines below.

[Gudahtt]

Changing the spacing, or some other unimportant aspect of the changelog format, is something we could do. But then it wouldn't be strictly compatible with the KeepAChangelog example changelog, and thus with other KeepAChangelog-related tooling. We could make it flexible, but then it would be less useful, because it can't apply the format for us automatically if it's flexible enough to accept both.

[danroc]

Update: Keep a Changelog has changed its own changelog file to match markdownlint defaults.

See: olivierlacan/keep-a-changelog#318