Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add fenced code block style rule (#224) (fixes #223).

Browse source
This commit is contained in:
Marius Lichtblau 2019-10-08 21:10:02 -07:00 • committed by David Anson
parent fd06a50ee5
commit e9b3cc4c18
17 changed files with 232 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

38
doc/Rules.md
View file

@ -1601,3 +1601,41 @@ To fix the violation, add a newline character to the end of the file:
This file ends with a newline.
[EOF]
```
<a name="md048"></a>
## MD048 - Code fence style
Tags: code
Aliases: code-fence-style
Parameters: style ("consistent", "tilde", "backtick"; default "consistent")
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.