Commit graph

5 commits

Author SHA1 Message Date
Marcel Amirault
d2cb8f785e Update docs to pass new markdownlint
Deletes extra spaces and line, makes lists consistent, and
fixes links.
2019-08-22 08:50:31 +00:00
Marcel Amirault
60dfca155c Add more rules to markdown lint check
Adds MD010 (Hard tabs), MD012 (blank lines), MD029 (ordered
list prefix), MD030 (spaces after list markers), and fixes
remaining docs that were failing these tests
2019-08-12 04:23:01 +00:00
Marcel Amirault
61e1a14925 Expand markdown linting rules for docs
MD002 - First header should be level 1
MD006 - Start bullets at beginning of line
MD019 - No multiple spaces after header style
MD022 - Headers surrounded by blank lines
MD025 - Only 1 level 1 header
MD028 - No blank lines within blockquote
MD038 - Spaces inside code span elements
2019-08-05 02:13:46 +00:00
Marcel Amirault
7f50358d1c Update markdown lint style and option files
Add commented lines explaining the file, and including
rules that should pass already, and commented out rules
that can be added in the future, for reference.
2019-07-15 01:42:24 +00:00
Markus Koller
385233981a Centralize config for markdownlint
The configuration is currently only specified in CI, by moving it into
`.mdlrc` we get immediate feedback locally in supported editors.

To ensure `mdl` is available it's also added to the `Gemfile`, though
CI will still use the version installed in the `gitlab-docs-lint` image.
2019-07-09 03:01:04 +00:00