Generate Rules.md and md###.md files from metadata, improve Parameters documentation by referencing schema.

This commit is contained in:
David Anson 2022-10-29 23:21:45 -07:00
parent 32c75ebfd9
commit 37baddcf27
110 changed files with 3875 additions and 179 deletions

38
doc/md046.md Normal file
View file

@ -0,0 +1,38 @@
# MD046 - Code block style
Tags: code
Aliases: code-block-style
Parameters:
* `style`: Block style (`string`, default `consistent`, values `consistent`/`fenced`/`indented`)
This rule is triggered when unwanted or different code block styles are used in
the same document.
In the default configuration this rule reports a violation for the following document:
<!-- markdownlint-disable code-block-style -->
Some text.
# Indented code
More text.
```ruby
# Fenced code
```
More text.
<!-- markdownlint-restore -->
To fix violations of this rule, use a consistent style (either indenting or code
fences).
The specified style can be specific (`fenced`, `indented`) or simply require
that usage be consistent within the document (`consistent`).
Rationale: Consistent formatting makes it easier to understand a document.