mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2025-09-22 05:40:48 +02:00
41 lines
752 B
Markdown
41 lines
752 B
Markdown
|
# MD048 - Code fence style
|
||
|
|
|
||
|
|
Tags: code
|
||
|
|
|
||
|
|
Aliases: code-fence-style
|
||
|
|
|
||
|
|
Parameters:
|
||
|
|
|
||
|
|
* `style`: Code fence style (`string`, default `consistent`, values `backtick`/`consistent`/`tilde`)
|
||
|
|
|
||
|
|
This rule is triggered when the symbols used in the document for fenced code
|
||
|
|
blocks do not match the configured code fence style:
|
||
|
|
|
||
|
|
````markdown
|
||
|
|
```ruby
|
||
|
|
# Fenced code
|
||
|
|
```
|
||
|
|
|
||
|
|
~~~ruby
|
||
|
|
# Fenced code
|
||
|
|
~~~
|
||
|
|
````
|
||
|
|
|
||
|
|
To fix this issue, use the configured code fence style throughout the
|
||
|
|
document:
|
||
|
|
|
||
|
|
````markdown
|
||
|
|
```ruby
|
||
|
|
# Fenced code
|
||
|
|
```
|
||
|
|
|
||
|
|
```ruby
|
||
|
|
# Fenced code
|
||
|
|
```
|
||
|
|
````
|
||
|
|
|
||
|
|
The configured list style can be a specific symbol to use (backtick, tilde), or
|
||
|
|
can require that usage be consistent within the document.
|
||
|
|
|
||
|
|
Rationale: Consistent formatting makes it easier to understand a document.
|