mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
39 lines
862 B
Markdown
39 lines
862 B
Markdown
|
# 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.
|