Package Exports
- remark-lint-list-item-indent
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-list-item-indent) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
remark-lint-list-item-indent
Warn when the spacing between a list item’s bullet and its content violates a given style.
Options: string
, either 'tab-size'
, 'mixed'
, or 'space'
,
default: 'tab-size'
.
Install
npm install --save remark-lint-list-item-indent
Example
When this rule is turned on, the following file
valid.md
is ok:
The below style is called `tab-size`.
* List
item.
Paragraph.
11. List
item.
Paragraph.
* List
item.
* List
item.
When this rule is 'mixed'
, the following file
valid.md
is ok:
* List item.
Paragraph.
11. List item
Paragraph.
* List
item.
* List
item.
When this rule is 'mixed'
, the following file
invalid.md
is not ok:
* List item.
1:5: Incorrect list-item indent: remove 2 spaces
When this rule is 'space'
, the following file
valid.md
is ok:
* List item.
Paragraph.
11. List item
Paragraph.
* List
item.
* List
item.
When this rule is 'space'
, the following file
invalid.md
is not ok:
* List
item.
1:5: Incorrect list-item indent: remove 2 spaces
When this rule is 'tab-size'
, the following file
invalid.md
is not ok:
* List
item.
1:3: Incorrect list-item indent: add 2 spaces
When 'invalid'
is passed in, the following error is given:
1:1: Invalid list-item indent style `invalid`: use either `'tab-size'`, `'space'`, or `'mixed'`