remark-lint-checkbox-content-indent - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "remark-lint-checkbox-content-indent",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "remark-lint rule to warn when list item checkboxes are followed by too much white-space",
		@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

		@@ -7,13 +7,12 @@ <!--This file is generated-->

		## Install
		## Presets

		```sh
		npm install --save remark-lint-checkbox-content-indent
		```
		This rule is not included in any default preset

		## Example

		When this rule is turned on, the following file
		`valid.md` is ok:
		##### `valid.md`

		###### In

		```markdown
		@@ -26,5 +25,10 @@ - [ ] List item

		When this rule is turned on, the following file
		`invalid.md` is not ok:
		###### Out

		No messages.

		##### `invalid.md`

		###### In

		```markdown
		@@ -37,2 +41,4 @@ - [ ] List item

		###### Out

		```text
		@@ -44,4 +50,47 @@ 2:7-2:8: Checkboxes should be followed by a single character

		## Install

		```sh
		npm install remark-lint-checkbox-content-indent
		```

		## Usage

		You probably want to use it on the CLI through a config file:

		```diff
		...
		"remarkConfig": {
		"plugins": [
		...
		"lint",
		+ "lint-checkbox-content-indent",
		...
		]
		}
		...
		```

		Or use it on the CLI directly

		```sh
		remark -u lint -u lint-checkbox-content-indent readme.md
		```

		Or use this on the API:

		```diff
		var remark = require('remark');
		var report = require('vfile-reporter');

		remark()
		.use(require('remark-lint'))
		+ .use(require('remark-lint-checkbox-content-indent'))
		.process('_Emphasis_ and importance', function (err, file) {
		console.error(report(err \|\| file));
		});
		```

		## License

		[MIT](https://github.com/wooorm/remark-lint/blob/master/LICENSE) © [Titus Wormer](http://wooorm.com)

New alerts