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

Update MD013 to allow excluding code and tables.

Browse source
This commit is contained in:
David Anson 2016-01-09 22:20:36 -08:00
parent 36eaa821d9
commit b7342485d9
5 changed files with 106 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/Rules.md
View file

@ -266,7 +266,7 @@ lines inside code blocks.
Tags: line_length
Parameters: line_length (number; default 80)
Parameters: line_length, code_blocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the
configured line length (default: 80 characters). To fix this, split the line
@ -276,6 +276,13 @@ This rule has an exception where there is no whitespace beyond the configured
line length. This allows you to still include items such as long URLs without
being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the `code_blocks` and/or `tables` parameters to false.
Code blocks are included in this rule by default since it is often a
requirement for document readability, and tentatively compatible with code
rules. Still, some languages do not lend themselves to short lines.
## MD014 - Dollar signs used before commands without showing output
Tags: code