remark-lint-no-emphasis-as-heading - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "remark-lint-no-emphasis-as-heading",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "remark-lint rule to warn when emphasis or importance is used instead of a heading",
		@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

		@@ -8,13 +8,16 @@ <!--This file is generated-->

		## Install
		## Presets

		```sh
		npm install --save remark-lint-no-emphasis-as-heading
		```
		This rule is included in the following presets:

		\| Preset \| Setting \|
		\| ------ \| ------- \|
		\| [`remark-preset-lint-markdown-style-guide`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-preset-lint-markdown-style-guide) \| \|

		## Example

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

		###### In

		```markdown
		@@ -26,5 +29,10 @@ # Foo

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

		No messages.

		##### `invalid.md`

		###### In

		```markdown
		@@ -40,2 +48,4 @@ Foo

		###### Out

		```text
		@@ -46,4 +56,47 @@ 1:1-1:6: Don’t use emphasis to introduce a section, use a heading

		## Install

		```sh
		npm install remark-lint-no-emphasis-as-heading
		```

		## Usage

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

		```diff
		...
		"remarkConfig": {
		"plugins": [
		...
		"lint",
		+ "lint-no-emphasis-as-heading",
		...
		]
		}
		...
		```

		Or use it on the CLI directly

		```sh
		remark -u lint -u lint-no-emphasis-as-heading 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-no-emphasis-as-heading'))
		.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