Line length Open
See the [HTML5 QR code docs](https://github.com/mebjas/html5-qrcode#documentation) for the scanner config.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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 up into multiple lines.
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. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
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.
Line length Open
- `qrbox: number | {width: number, height: number}`: The dimensions for the QR scanning area. If not set, the entire area of the video stream will be used by the scanner.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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 up into multiple lines.
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. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
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.
Header levels should only increment by one level at a time Open
### Properties
- Read upRead up
- Exclude checks
MD001 - Header levels should only increment by one level at a time
Tags: headers
Aliases: header-increment
This rule is triggered when you skip header levels in a markdown document, for example:
# Header 1
### Header 3
We skipped out a 2nd level header in this document
When using multiple header levels, nested headers should increase by only one level at a time:
# Header 1
## Header 2
### Header 3
#### Header 4
## Another Header 2
### Another Header 3
Line length Open
- `formatsToSupport: List of Html5QrcodeSupportedFormats`: Limit the code formats that can be scanned. See [Html5QrcodeSupportedFormats](https://github.com/mebjas/html5-qrcode#documentation:~:text=library.%0A%20*/%0Aenum-,Html5QrcodeSupportedFormats,-%7B%0A%20%20QR_CODE%20%3D).
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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 up into multiple lines.
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. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
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.
Fenced code blocks should be surrounded by blank lines Open
```yaml
- Read upRead up
- Exclude checks
MD031 - Fenced code blocks should be surrounded by blank lines
Tags: code, blank_lines
Aliases: blanks-around-fences
This rule is triggered when fenced code blocks are either not preceded or not followed by a blank line:
Some text
```
Code block
```
```
Another code block
```
Some more text
To fix this, ensure that all fenced code blocks have a blank line both before and after (except where the block is at the beginning or end of the document):
Some text
```
Code block
```
```
Another code block
```
Some more text
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them.
Line length Open
When a code is scanned by the QR scanner, the value of the block is set to the decoded result from the scan. The value is an object, which has the following fields:
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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 up into multiple lines.
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. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
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.
Line length Open
- `inactiveByDefault: boolean`: Determines whether or not the scanner is started when it is mounted.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length
Parameters: linelength, ignorecodeblocks, codeblocks, tables (number; default 80, boolean; default false, boolean; default true, 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 up into multiple lines.
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. To
do this, set the ignore_code_blocks
parameter to true. To exclude this rule
for tables set the tables
parameters to false. Setting the parameter
code_blocks
to false to exclude the rule for code blocks is deprecated and
will be removed in a future release.
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.