The shortcut syntax is used by GitHub-style alerts and trigger a lint
warning.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Headings should be surrounded by blank lines
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headings that don't have a blank line before, and will parse them as regular text.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Heading markup should start on the first column of a line, otherwise we
risk it being rendered as a paragraph, per the markdown spec.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Formatting for tables wasn't guarded by markdownlint validation rules,
which increases the risk of releasing incorrectly formatted tables.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This adds information on how the docs use linting, and more detailed
instructions on how to enable it in an IDE, using VSCode as a concrete
and widespread example.
Additionally, to do this, we add a duplicate style config for
markdownlint in JSON format for the Node.js implementation of
markdownlint that is used by various editor plugins. These both
implement the same core set of warnings, and appear to function
identically.
David Karlsson