diff --git a/packages/remark-lint-blockquote-indentation/readme.md b/packages/remark-lint-blockquote-indentation/readme.md index 62bb5960..f80982ba 100644 --- a/packages/remark-lint-blockquote-indentation/readme.md +++ b/packages/remark-lint-blockquote-indentation/readme.md @@ -2,6 +2,14 @@ # remark-lint-blockquote-indentation +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when blockquotes are indented too much or too little. Options: `number` or `'consistent'`, default: `'consistent'`. @@ -81,11 +89,13 @@ Paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-blockquote-indentation ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -122,6 +132,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-blockquote-indentation.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-blockquote-indentation + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-blockquote-indentation.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-blockquote-indentation + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-checkbox-character-style/readme.md b/packages/remark-lint-checkbox-character-style/readme.md index 4a020724..d7c201a3 100644 --- a/packages/remark-lint-checkbox-character-style/readme.md +++ b/packages/remark-lint-checkbox-character-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-checkbox-character-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when list item checkboxes violate a given style. Options: `Object` or `'consistent'`, default: `'consistent'`. @@ -142,11 +150,13 @@ When configured with `{ checked: '!' }`. ## Install +[npm][]: + ```sh npm install remark-lint-checkbox-character-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -183,6 +193,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-checkbox-character-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-checkbox-character-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-checkbox-character-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-checkbox-character-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-checkbox-content-indent/readme.md b/packages/remark-lint-checkbox-content-indent/readme.md index 54df1990..cac154a5 100644 --- a/packages/remark-lint-checkbox-content-indent/readme.md +++ b/packages/remark-lint-checkbox-content-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-checkbox-content-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when list item checkboxes are followed by too much whitespace. ## Presets @@ -46,11 +54,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-checkbox-content-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -87,6 +97,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-checkbox-content-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-checkbox-content-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-checkbox-content-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-checkbox-content-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-code-block-style/readme.md b/packages/remark-lint-code-block-style/readme.md index 85e24cac..72bdf71b 100644 --- a/packages/remark-lint-code-block-style/readme.md +++ b/packages/remark-lint-code-block-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-code-block-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when code blocks do not adhere to a given style. Options: `'consistent'`, `'fenced'`, or `'indented'`, default: `'consistent'`. @@ -150,11 +158,13 @@ When configured with `'invalid'`. ## Install +[npm][]: + ```sh npm install remark-lint-code-block-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -191,6 +201,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-code-block-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-code-block-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-code-block-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-code-block-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-definition-case/readme.md b/packages/remark-lint-definition-case/readme.md index bbc2f63a..64596b1c 100644 --- a/packages/remark-lint-definition-case/readme.md +++ b/packages/remark-lint-definition-case/readme.md @@ -2,6 +2,14 @@ # remark-lint-definition-case +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when definition labels are not lowercase. ## Presets @@ -42,11 +50,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-definition-case ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -83,6 +93,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-definition-case.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-definition-case + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-definition-case.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-definition-case + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-definition-spacing/readme.md b/packages/remark-lint-definition-spacing/readme.md index 78457ee7..69ec46d7 100644 --- a/packages/remark-lint-definition-spacing/readme.md +++ b/packages/remark-lint-definition-spacing/readme.md @@ -2,6 +2,14 @@ # remark-lint-definition-spacing +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when consecutive whitespace is used in a definition. ## Presets @@ -44,11 +52,13 @@ Note: `·` represents a space. ## Install +[npm][]: + ```sh npm install remark-lint-definition-spacing ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -85,6 +95,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-definition-spacing.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-definition-spacing + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-definition-spacing.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-definition-spacing + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-emphasis-marker/readme.md b/packages/remark-lint-emphasis-marker/readme.md index eea12054..a635b1af 100644 --- a/packages/remark-lint-emphasis-marker/readme.md +++ b/packages/remark-lint-emphasis-marker/readme.md @@ -2,6 +2,14 @@ # remark-lint-emphasis-marker +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for violating emphasis markers. Options: `'consistent'`, `'*'`, or `'_'`, default: `'consistent'`. @@ -118,11 +126,13 @@ When configured with `'invalid'`. ## Install +[npm][]: + ```sh npm install remark-lint-emphasis-marker ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -159,6 +169,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-emphasis-marker.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-emphasis-marker + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-emphasis-marker.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-emphasis-marker + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-fenced-code-flag/readme.md b/packages/remark-lint-fenced-code-flag/readme.md index 76afba95..4e2219b9 100644 --- a/packages/remark-lint-fenced-code-flag/readme.md +++ b/packages/remark-lint-fenced-code-flag/readme.md @@ -2,6 +2,14 @@ # remark-lint-fenced-code-flag +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Check fenced code block flags. Options: `Array.` or `Object`, optional. @@ -123,11 +131,13 @@ bravo(); ## Install +[npm][]: + ```sh npm install remark-lint-fenced-code-flag ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -164,6 +174,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-fenced-code-flag.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-fenced-code-flag + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-fenced-code-flag.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-fenced-code-flag + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-fenced-code-marker/readme.md b/packages/remark-lint-fenced-code-marker/readme.md index 4cc1bafc..a634c426 100644 --- a/packages/remark-lint-fenced-code-marker/readme.md +++ b/packages/remark-lint-fenced-code-marker/readme.md @@ -2,6 +2,14 @@ # remark-lint-fenced-code-marker +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for violating fenced code markers. Options: ``'`'``, `'~'`, or `'consistent'`, default: `'consistent'`. @@ -117,11 +125,13 @@ When configured with `'!'`. ## Install +[npm][]: + ```sh npm install remark-lint-fenced-code-marker ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -158,6 +168,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-fenced-code-marker.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-fenced-code-marker + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-fenced-code-marker.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-fenced-code-marker + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-file-extension/readme.md b/packages/remark-lint-file-extension/readme.md index 6293ce3d..d1d708f4 100644 --- a/packages/remark-lint-file-extension/readme.md +++ b/packages/remark-lint-file-extension/readme.md @@ -2,6 +2,14 @@ # remark-lint-file-extension +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the file extension differ from the preferred extension. Does not warn when given documents have no file extensions (such as @@ -49,11 +57,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-file-extension ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -90,6 +100,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-file-extension.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-file-extension + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-file-extension.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-file-extension + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-final-definition/readme.md b/packages/remark-lint-final-definition/readme.md index 5c5913a4..55552d72 100644 --- a/packages/remark-lint-final-definition/readme.md +++ b/packages/remark-lint-final-definition/readme.md @@ -2,6 +2,14 @@ # remark-lint-final-definition +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when definitions are placed somewhere other than at the end of the file. @@ -49,11 +57,13 @@ Another paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-final-definition ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -90,6 +100,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-final-definition.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-final-definition + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-final-definition.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-final-definition + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-final-newline/readme.md b/packages/remark-lint-final-newline/readme.md index 338e4bb4..ce0c2f82 100644 --- a/packages/remark-lint-final-newline/readme.md +++ b/packages/remark-lint-final-newline/readme.md @@ -2,6 +2,14 @@ # remark-lint-final-newline +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when a line feed at the end of a file is missing. Empty files are allowed. @@ -57,11 +65,13 @@ This rule is included in the following presets: ## Install +[npm][]: + ```sh npm install remark-lint-final-newline ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -98,6 +108,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-final-newline.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-final-newline + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-final-newline.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-final-newline + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-first-heading-level/readme.md b/packages/remark-lint-first-heading-level/readme.md index 76ba7545..ee1da34d 100644 --- a/packages/remark-lint-first-heading-level/readme.md +++ b/packages/remark-lint-first-heading-level/readme.md @@ -2,6 +2,14 @@ # remark-lint-first-heading-level +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the first heading has a level other than a specified value. Options: `number`, default: `1`. @@ -154,11 +162,13 @@ Paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-first-heading-level ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -195,6 +205,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-first-heading-level.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-first-heading-level + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-first-heading-level.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-first-heading-level + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-hard-break-spaces/readme.md b/packages/remark-lint-hard-break-spaces/readme.md index 708059d2..9a1d0af7 100644 --- a/packages/remark-lint-hard-break-spaces/readme.md +++ b/packages/remark-lint-hard-break-spaces/readme.md @@ -2,6 +2,14 @@ # remark-lint-hard-break-spaces +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when too many spaces are used to create a hard break. ## Presets @@ -49,11 +57,13 @@ dolor sit amet. ## Install +[npm][]: + ```sh npm install remark-lint-hard-break-spaces ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -90,6 +100,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-hard-break-spaces.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-hard-break-spaces + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-hard-break-spaces.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-hard-break-spaces + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-heading-increment/readme.md b/packages/remark-lint-heading-increment/readme.md index 2b529ebd..806f117f 100644 --- a/packages/remark-lint-heading-increment/readme.md +++ b/packages/remark-lint-heading-increment/readme.md @@ -2,6 +2,14 @@ # remark-lint-heading-increment +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when headings increment with more than 1 level at a time. ## Presets @@ -46,11 +54,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-heading-increment ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -87,6 +97,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-heading-increment.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-heading-increment + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-heading-increment.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-heading-increment + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-heading-style/readme.md b/packages/remark-lint-heading-style/readme.md index 00992a5c..54b93b24 100644 --- a/packages/remark-lint-heading-style/readme.md +++ b/packages/remark-lint-heading-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-heading-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when a heading does not conform to a given style. Options: `'consistent'`, `'atx'`, `'atx-closed'`, or `'setext'`, @@ -112,11 +120,13 @@ Juliett ## Install +[npm][]: + ```sh npm install remark-lint-heading-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -153,6 +163,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-heading-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-heading-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-heading-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-heading-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-linebreak-style/readme.md b/packages/remark-lint-linebreak-style/readme.md index e0904bc4..5a8b9940 100644 --- a/packages/remark-lint-linebreak-style/readme.md +++ b/packages/remark-lint-linebreak-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-linebreak-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when linebreaks violate a given or detected style. Options: either `'unix'` (for `\n`, denoted as `␊`), `'windows'` (for `\r\n`, @@ -90,11 +98,13 @@ Alpha␊ ## Install +[npm][]: + ```sh npm install remark-lint-linebreak-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -131,6 +141,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-linebreak-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-linebreak-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-linebreak-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-linebreak-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-link-title-style/readme.md b/packages/remark-lint-link-title-style/readme.md index 1aaab131..1f020c09 100644 --- a/packages/remark-lint-link-title-style/readme.md +++ b/packages/remark-lint-link-title-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-link-title-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when link and definition titles occur with incorrect quotes. Options: `'consistent'`, `'"'`, `'\''`, or `'()'`, default: `'consistent'`. @@ -162,11 +170,13 @@ When configured with `'.'`. ## Install +[npm][]: + ```sh npm install remark-lint-link-title-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -203,6 +213,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-link-title-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-link-title-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-link-title-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-link-title-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-list-item-bullet-indent/readme.md b/packages/remark-lint-list-item-bullet-indent/readme.md index 8ffb6847..9d4eca9c 100644 --- a/packages/remark-lint-list-item-bullet-indent/readme.md +++ b/packages/remark-lint-list-item-bullet-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-list-item-bullet-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when list item bullets are indented. ## Fix @@ -59,11 +67,13 @@ Paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-list-item-bullet-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -100,6 +110,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-list-item-bullet-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-list-item-bullet-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-list-item-bullet-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-list-item-bullet-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-list-item-content-indent/readme.md b/packages/remark-lint-list-item-content-indent/readme.md index 4a5c95f8..1b2b8155 100644 --- a/packages/remark-lint-list-item-content-indent/readme.md +++ b/packages/remark-lint-list-item-content-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-list-item-content-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the content of a list item has mixed indentation. ## Presets @@ -49,11 +57,13 @@ Note: `·` represents a space. ## Install +[npm][]: + ```sh npm install remark-lint-list-item-content-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -90,6 +100,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-list-item-content-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-list-item-content-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-list-item-content-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-list-item-content-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-list-item-indent/readme.md b/packages/remark-lint-list-item-indent/readme.md index 0ba6cec6..535b8f9e 100644 --- a/packages/remark-lint-list-item-indent/readme.md +++ b/packages/remark-lint-list-item-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-list-item-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the spacing between a list item’s bullet and its content violates a given style. @@ -183,11 +191,13 @@ When configured with `'invalid'`. ## Install +[npm][]: + ```sh npm install remark-lint-list-item-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -224,6 +234,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-list-item-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-list-item-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-list-item-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-list-item-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-list-item-spacing/readme.md b/packages/remark-lint-list-item-spacing/readme.md index 9447df76..e5b16862 100644 --- a/packages/remark-lint-list-item-spacing/readme.md +++ b/packages/remark-lint-list-item-spacing/readme.md @@ -2,6 +2,14 @@ # remark-lint-list-item-spacing +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when list looseness is incorrect, such as being tight when it should be loose, and vice versa. @@ -148,11 +156,13 @@ A loose list: ## Install +[npm][]: + ```sh npm install remark-lint-list-item-spacing ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -189,6 +199,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-list-item-spacing.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-list-item-spacing + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-list-item-spacing.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-list-item-spacing + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-maximum-heading-length/readme.md b/packages/remark-lint-maximum-heading-length/readme.md index 3608e242..c427db08 100644 --- a/packages/remark-lint-maximum-heading-length/readme.md +++ b/packages/remark-lint-maximum-heading-length/readme.md @@ -2,6 +2,14 @@ # remark-lint-maximum-heading-length +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when headings are too long. Options: `number`, default: `60`. @@ -50,11 +58,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-maximum-heading-length ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -91,6 +101,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-maximum-heading-length.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-maximum-heading-length + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-maximum-heading-length.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-maximum-heading-length + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-maximum-line-length/readme.md b/packages/remark-lint-maximum-line-length/readme.md index 02b995fe..ffaa2686 100644 --- a/packages/remark-lint-maximum-line-length/readme.md +++ b/packages/remark-lint-maximum-line-length/readme.md @@ -2,6 +2,14 @@ # remark-lint-maximum-line-length +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when lines are too long. Options: `number`, default: `80`. @@ -141,11 +149,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-maximum-line-length ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -182,6 +192,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-maximum-line-length.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-maximum-line-length + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-maximum-line-length.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-maximum-line-length + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-auto-link-without-protocol/readme.md b/packages/remark-lint-no-auto-link-without-protocol/readme.md index bf23caf1..489e7e6a 100644 --- a/packages/remark-lint-no-auto-link-without-protocol/readme.md +++ b/packages/remark-lint-no-auto-link-without-protocol/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-auto-link-without-protocol +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for autolinks without protocol. Autolinks are URLs enclosed in `<` (less-than) and `>` (greater-than) characters. @@ -57,11 +65,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-auto-link-without-protocol ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -98,6 +108,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-auto-link-without-protocol.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-auto-link-without-protocol + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-auto-link-without-protocol.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-auto-link-without-protocol + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-blockquote-without-marker/readme.md b/packages/remark-lint-no-blockquote-without-marker/readme.md index d934c7b5..287e6133 100644 --- a/packages/remark-lint-no-blockquote-without-marker/readme.md +++ b/packages/remark-lint-no-blockquote-without-marker/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-blockquote-without-marker +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when blank lines without `>` (greater-than) markers are found in a blockquote. @@ -56,11 +64,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-blockquote-without-marker ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -97,6 +107,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-blockquote-without-marker.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-blockquote-without-marker + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-blockquote-without-marker.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-blockquote-without-marker + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-consecutive-blank-lines/readme.md b/packages/remark-lint-no-consecutive-blank-lines/readme.md index 540d9763..737ef603 100644 --- a/packages/remark-lint-no-consecutive-blank-lines/readme.md +++ b/packages/remark-lint-no-consecutive-blank-lines/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-consecutive-blank-lines +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for too many consecutive blank lines. Knows about the extra line needed between a list and indented code, and two lists. @@ -90,11 +98,13 @@ Foo... ## Install +[npm][]: + ```sh npm install remark-lint-no-consecutive-blank-lines ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -131,6 +141,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-consecutive-blank-lines.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-consecutive-blank-lines + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-consecutive-blank-lines.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-consecutive-blank-lines + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-duplicate-definitions/readme.md b/packages/remark-lint-no-duplicate-definitions/readme.md index 9fa6c078..2fa24cbf 100644 --- a/packages/remark-lint-no-duplicate-definitions/readme.md +++ b/packages/remark-lint-no-duplicate-definitions/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-duplicate-definitions +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when duplicate definitions are found. ## Presets @@ -44,11 +52,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-duplicate-definitions ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -85,6 +95,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-duplicate-definitions.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-duplicate-definitions + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-duplicate-definitions.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-duplicate-definitions + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-duplicate-headings-in-section/readme.md b/packages/remark-lint-no-duplicate-headings-in-section/readme.md index 784d7479..6b216697 100644 --- a/packages/remark-lint-no-duplicate-headings-in-section/readme.md +++ b/packages/remark-lint-no-duplicate-headings-in-section/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-duplicate-headings-in-section +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when duplicate headings are found, but only when on the same level, “in” the same section. @@ -57,11 +65,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-duplicate-headings-in-section ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -98,6 +108,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-duplicate-headings-in-section.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-duplicate-headings-in-section + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-duplicate-headings-in-section.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-duplicate-headings-in-section + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-duplicate-headings/readme.md b/packages/remark-lint-no-duplicate-headings/readme.md index c1ffcf77..6105119c 100644 --- a/packages/remark-lint-no-duplicate-headings/readme.md +++ b/packages/remark-lint-no-duplicate-headings/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-duplicate-headings +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when duplicate headings are found. ## Presets @@ -49,11 +57,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-duplicate-headings ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -90,6 +100,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-duplicate-headings.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-duplicate-headings + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-duplicate-headings.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-duplicate-headings + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-emphasis-as-heading/readme.md b/packages/remark-lint-no-emphasis-as-heading/readme.md index d873133b..2fa31a35 100644 --- a/packages/remark-lint-no-emphasis-as-heading/readme.md +++ b/packages/remark-lint-no-emphasis-as-heading/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-emphasis-as-heading +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when emphasis (including strong), instead of a heading, introduces a paragraph. @@ -52,11 +60,13 @@ Quux. ## Install +[npm][]: + ```sh npm install remark-lint-no-emphasis-as-heading ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -93,6 +103,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-emphasis-as-heading.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-emphasis-as-heading + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-emphasis-as-heading.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-emphasis-as-heading + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-empty-url/readme.md b/packages/remark-lint-no-empty-url/readme.md index d80440ad..98ee16ca 100644 --- a/packages/remark-lint-no-empty-url/readme.md +++ b/packages/remark-lint-no-empty-url/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-empty-url +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for empty URLs in links and images. ## Presets @@ -43,11 +51,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-empty-url ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -84,6 +94,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-empty-url.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-empty-url + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-empty-url.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-empty-url + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-file-name-articles/readme.md b/packages/remark-lint-no-file-name-articles/readme.md index 13f3e657..c1684453 100644 --- a/packages/remark-lint-no-file-name-articles/readme.md +++ b/packages/remark-lint-no-file-name-articles/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-file-name-articles +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when file names start with an article. ## Presets @@ -54,11 +62,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-file-name-articles ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -95,6 +105,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-file-name-articles.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-file-name-articles + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-file-name-articles.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-file-name-articles + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-file-name-consecutive-dashes/readme.md b/packages/remark-lint-no-file-name-consecutive-dashes/readme.md index ac464dac..ce9a33e7 100644 --- a/packages/remark-lint-no-file-name-consecutive-dashes/readme.md +++ b/packages/remark-lint-no-file-name-consecutive-dashes/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-file-name-consecutive-dashes +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when file names contain consecutive dashes. ## Presets @@ -30,11 +38,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-file-name-consecutive-dashes ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -71,6 +81,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-file-name-consecutive-dashes.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-file-name-consecutive-dashes + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-file-name-consecutive-dashes.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-file-name-consecutive-dashes + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-file-name-irregular-characters/readme.md b/packages/remark-lint-no-file-name-irregular-characters/readme.md index 472935e3..0cbb3c32 100644 --- a/packages/remark-lint-no-file-name-irregular-characters/readme.md +++ b/packages/remark-lint-no-file-name-irregular-characters/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-file-name-irregular-characters +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when file names contain irregular characters: characters other than alphanumericals (`a-zA-Z0-9`), hyphen-minus (`-`), and dots (`.`, full stops). @@ -63,11 +71,13 @@ When configured with `'\\.a-z0-9'`. ## Install +[npm][]: + ```sh npm install remark-lint-no-file-name-irregular-characters ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -104,6 +114,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-file-name-irregular-characters.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-file-name-irregular-characters + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-file-name-irregular-characters.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-file-name-irregular-characters + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-file-name-mixed-case/readme.md b/packages/remark-lint-no-file-name-mixed-case/readme.md index 7c8b3ec1..22554283 100644 --- a/packages/remark-lint-no-file-name-mixed-case/readme.md +++ b/packages/remark-lint-no-file-name-mixed-case/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-file-name-mixed-case +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when file names use mixed case: both upper- and lowercase characters. ## Presets @@ -36,11 +44,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-file-name-mixed-case ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -77,6 +87,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-file-name-mixed-case.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-file-name-mixed-case + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-file-name-mixed-case.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-file-name-mixed-case + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-file-name-outer-dashes/readme.md b/packages/remark-lint-no-file-name-outer-dashes/readme.md index 2f508e74..9b59ccea 100644 --- a/packages/remark-lint-no-file-name-outer-dashes/readme.md +++ b/packages/remark-lint-no-file-name-outer-dashes/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-file-name-outer-dashes +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when file names contain initial or final dashes (hyphen-minus, `-`). ## Presets @@ -38,11 +46,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-file-name-outer-dashes ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -79,6 +89,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-file-name-outer-dashes.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-file-name-outer-dashes + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-file-name-outer-dashes.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-file-name-outer-dashes + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-heading-content-indent/readme.md b/packages/remark-lint-no-heading-content-indent/readme.md index 8136a467..b7428642 100644 --- a/packages/remark-lint-no-heading-content-indent/readme.md +++ b/packages/remark-lint-no-heading-content-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-heading-content-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when content of headings is indented. ## Fix @@ -102,11 +110,13 @@ In pedantic mode, headings without spacing can also be detected: ## Install +[npm][]: + ```sh npm install remark-lint-no-heading-content-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -143,6 +153,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-heading-content-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-heading-content-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-heading-content-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-heading-content-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-heading-indent/readme.md b/packages/remark-lint-no-heading-indent/readme.md index 02cd8746..c41ab673 100644 --- a/packages/remark-lint-no-heading-indent/readme.md +++ b/packages/remark-lint-no-heading-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-heading-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when a heading is indented. ## Fix @@ -69,11 +77,13 @@ Note: `·` represents a space. ## Install +[npm][]: + ```sh npm install remark-lint-no-heading-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -110,6 +120,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-heading-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-heading-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-heading-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-heading-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-heading-like-paragraph/readme.md b/packages/remark-lint-no-heading-like-paragraph/readme.md index e80a2ade..edeb4e70 100644 --- a/packages/remark-lint-no-heading-like-paragraph/readme.md +++ b/packages/remark-lint-no-heading-like-paragraph/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-heading-like-paragraph +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for h7+ “headings”. ## Presets @@ -42,11 +50,13 @@ Delta. ## Install +[npm][]: + ```sh npm install remark-lint-no-heading-like-paragraph ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -83,6 +93,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-heading-like-paragraph.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-heading-like-paragraph + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-heading-like-paragraph.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-heading-like-paragraph + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-heading-punctuation/readme.md b/packages/remark-lint-no-heading-punctuation/readme.md index a8600291..1532c3c2 100644 --- a/packages/remark-lint-no-heading-punctuation/readme.md +++ b/packages/remark-lint-no-heading-punctuation/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-heading-punctuation +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when a heading ends with a group of characters. Options: `string`, default: `'.,;:!?'`. @@ -73,11 +81,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-heading-punctuation ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -114,6 +124,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-heading-punctuation.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-heading-punctuation + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-heading-punctuation.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-heading-punctuation + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-html/readme.md b/packages/remark-lint-no-html/readme.md index 624ef966..7bf24f23 100644 --- a/packages/remark-lint-no-html/readme.md +++ b/packages/remark-lint-no-html/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-html +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when HTML nodes are used. Ignores comments, because they are used by `remark`, `remark-lint`, other @@ -43,11 +51,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-html ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -84,6 +94,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-html.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-html + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-html.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-html + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-inline-padding/readme.md b/packages/remark-lint-no-inline-padding/readme.md index d31d4c98..fffbf427 100644 --- a/packages/remark-lint-no-inline-padding/readme.md +++ b/packages/remark-lint-no-inline-padding/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-inline-padding +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when phrasing content is padded with spaces between their markers and content. @@ -48,11 +56,13 @@ Alpha, * bravo *, _ charlie _, [ delta ](http://echo.fox/trot) ## Install +[npm][]: + ```sh npm install remark-lint-no-inline-padding ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -89,6 +99,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-inline-padding.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-inline-padding + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-inline-padding.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-inline-padding + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-literal-urls/readme.md b/packages/remark-lint-no-literal-urls/readme.md index 034a1b1f..90e1c103 100644 --- a/packages/remark-lint-no-literal-urls/readme.md +++ b/packages/remark-lint-no-literal-urls/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-literal-urls +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for literal URLs in text. URLs are treated as links in some Markdown vendors, but not in others. To make sure they are always linked, wrap them in `<` (less-than) and `>` @@ -55,11 +63,13 @@ http://foo.bar/baz ## Install +[npm][]: + ```sh npm install remark-lint-no-literal-urls ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -96,6 +106,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-literal-urls.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-literal-urls + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-literal-urls.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-literal-urls + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-missing-blank-lines/readme.md b/packages/remark-lint-no-missing-blank-lines/readme.md index b82caef9..a673821e 100644 --- a/packages/remark-lint-no-missing-blank-lines/readme.md +++ b/packages/remark-lint-no-missing-blank-lines/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-missing-blank-lines +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when missing blank lines before block content (and frontmatter content). @@ -90,11 +98,13 @@ Paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-no-missing-blank-lines ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -131,6 +141,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-missing-blank-lines.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-missing-blank-lines + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-missing-blank-lines.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-missing-blank-lines + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-multiple-toplevel-headings/readme.md b/packages/remark-lint-no-multiple-toplevel-headings/readme.md index c0afb3a1..53c07214 100644 --- a/packages/remark-lint-no-multiple-toplevel-headings/readme.md +++ b/packages/remark-lint-no-multiple-toplevel-headings/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-multiple-toplevel-headings +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when multiple top level headings are used. Options: `number`, default: `1`. @@ -52,11 +60,13 @@ When configured with `1`. ## Install +[npm][]: + ```sh npm install remark-lint-no-multiple-toplevel-headings ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -93,6 +103,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-multiple-toplevel-headings.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-multiple-toplevel-headings + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-multiple-toplevel-headings.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-multiple-toplevel-headings + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-paragraph-content-indent/readme.md b/packages/remark-lint-no-paragraph-content-indent/readme.md index 70242c8a..2455bbdd 100644 --- a/packages/remark-lint-no-paragraph-content-indent/readme.md +++ b/packages/remark-lint-no-paragraph-content-indent/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-paragraph-content-indent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the content in paragraphs is indented. ## Presets @@ -95,11 +103,13 @@ Bravo ## Install +[npm][]: + ```sh npm install remark-lint-no-paragraph-content-indent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -136,6 +146,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-paragraph-content-indent.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-paragraph-content-indent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-paragraph-content-indent.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-paragraph-content-indent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-reference-like-url/readme.md b/packages/remark-lint-no-reference-like-url/readme.md index d3066b92..c177f017 100644 --- a/packages/remark-lint-no-reference-like-url/readme.md +++ b/packages/remark-lint-no-reference-like-url/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-reference-like-url +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when URLs are also defined identifiers. ## Presets @@ -42,11 +50,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-reference-like-url ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -83,6 +93,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-reference-like-url.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-reference-like-url + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-reference-like-url.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-reference-like-url + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-shell-dollars/readme.md b/packages/remark-lint-no-shell-dollars/readme.md index da24cda8..86862fb5 100644 --- a/packages/remark-lint-no-shell-dollars/readme.md +++ b/packages/remark-lint-no-shell-dollars/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-shell-dollars +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when shell code is prefixed by `$` (dollar sign) characters. Ignores indented code blocks and fenced code blocks without language flag. @@ -67,11 +75,13 @@ $ echo a > file ## Install +[npm][]: + ```sh npm install remark-lint-no-shell-dollars ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -108,6 +118,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-shell-dollars.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-shell-dollars + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-shell-dollars.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-shell-dollars + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-shortcut-reference-image/readme.md b/packages/remark-lint-no-shortcut-reference-image/readme.md index a5ad9adc..e2a804a3 100644 --- a/packages/remark-lint-no-shortcut-reference-image/readme.md +++ b/packages/remark-lint-no-shortcut-reference-image/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-shortcut-reference-image +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when shortcut reference images are used. Shortcut references render as images when a definition is found, and as @@ -53,11 +61,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-shortcut-reference-image ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -94,6 +104,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-shortcut-reference-image.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-shortcut-reference-image + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-shortcut-reference-image.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-shortcut-reference-image + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-shortcut-reference-link/readme.md b/packages/remark-lint-no-shortcut-reference-link/readme.md index 99cb6d66..c3537a9f 100644 --- a/packages/remark-lint-no-shortcut-reference-link/readme.md +++ b/packages/remark-lint-no-shortcut-reference-link/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-shortcut-reference-link +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when shortcut reference links are used. Shortcut references render as links when a definition is found, and as @@ -53,11 +61,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-shortcut-reference-link ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -94,6 +104,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-shortcut-reference-link.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-shortcut-reference-link + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-shortcut-reference-link.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-shortcut-reference-link + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-table-indentation/readme.md b/packages/remark-lint-no-table-indentation/readme.md index dbf92f85..3845404f 100644 --- a/packages/remark-lint-no-table-indentation/readme.md +++ b/packages/remark-lint-no-table-indentation/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-table-indentation +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when tables are indented. ## Fix @@ -61,11 +69,13 @@ Paragraph. ## Install +[npm][]: + ```sh npm install remark-lint-no-table-indentation ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -102,6 +112,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-table-indentation.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-table-indentation + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-table-indentation.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-table-indentation + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-tabs/readme.md b/packages/remark-lint-no-tabs/readme.md index 5632d12f..113f3a8e 100644 --- a/packages/remark-lint-no-tabs/readme.md +++ b/packages/remark-lint-no-tabs/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-tabs +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when hard tabs (`\t`) are used instead of spaces. ## Fix @@ -73,11 +81,13 @@ And this is a tab as the last character.» ## Install +[npm][]: + ```sh npm install remark-lint-no-tabs ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -114,6 +124,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-tabs.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-tabs + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-tabs.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-tabs + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-undefined-references/readme.md b/packages/remark-lint-no-undefined-references/readme.md index 86dab0d1..cb0dd417 100644 --- a/packages/remark-lint-no-undefined-references/readme.md +++ b/packages/remark-lint-no-undefined-references/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-undefined-references +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when references to undefined definitions are found. Options: `Object`, optional. @@ -64,11 +72,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-undefined-references ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -105,6 +115,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-undefined-references.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-undefined-references + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-undefined-references.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-undefined-references + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-no-unused-definitions/readme.md b/packages/remark-lint-no-unused-definitions/readme.md index 203e5942..5ab9d5d2 100644 --- a/packages/remark-lint-no-unused-definitions/readme.md +++ b/packages/remark-lint-no-unused-definitions/readme.md @@ -2,6 +2,14 @@ # remark-lint-no-unused-definitions +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when unused definitions are found. ## Presets @@ -44,11 +52,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-no-unused-definitions ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -85,6 +95,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-no-unused-definitions.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-no-unused-definitions + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-no-unused-definitions.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-no-unused-definitions + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-ordered-list-marker-style/readme.md b/packages/remark-lint-ordered-list-marker-style/readme.md index bdf6b7ba..43dd501d 100644 --- a/packages/remark-lint-ordered-list-marker-style/readme.md +++ b/packages/remark-lint-ordered-list-marker-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-ordered-list-marker-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the list item marker style of ordered lists violate a given style. Options: `'consistent'`, `'.'`, or `')'`, default: `'consistent'`. @@ -104,11 +112,13 @@ When configured with `'!'`. ## Install +[npm][]: + ```sh npm install remark-lint-ordered-list-marker-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -145,6 +155,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-ordered-list-marker-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-ordered-list-marker-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-ordered-list-marker-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-ordered-list-marker-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-ordered-list-marker-value/readme.md b/packages/remark-lint-ordered-list-marker-value/readme.md index 8d4fc5ae..157fbfab 100644 --- a/packages/remark-lint-ordered-list-marker-value/readme.md +++ b/packages/remark-lint-ordered-list-marker-value/readme.md @@ -2,6 +2,14 @@ # remark-lint-ordered-list-marker-value +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the list item marker values of ordered lists violate a given style. @@ -191,11 +199,13 @@ When configured with `'invalid'`. ## Install +[npm][]: + ```sh npm install remark-lint-ordered-list-marker-value ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -232,6 +242,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-ordered-list-marker-value.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-ordered-list-marker-value + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-ordered-list-marker-value.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-ordered-list-marker-value + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-rule-style/readme.md b/packages/remark-lint-rule-style/readme.md index 2614c305..e7be7c79 100644 --- a/packages/remark-lint-rule-style/readme.md +++ b/packages/remark-lint-rule-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-rule-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the thematic breaks (horizontal rules) violate a given or detected style. @@ -97,11 +105,13 @@ When configured with `'!!!'`. ## Install +[npm][]: + ```sh npm install remark-lint-rule-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -138,6 +148,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-rule-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-rule-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-rule-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-rule-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-strong-marker/readme.md b/packages/remark-lint-strong-marker/readme.md index f6cdab40..38670755 100644 --- a/packages/remark-lint-strong-marker/readme.md +++ b/packages/remark-lint-strong-marker/readme.md @@ -2,6 +2,14 @@ # remark-lint-strong-marker +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn for violating importance (strong) markers. Options: `'consistent'`, `'*'`, or `'_'`, default: `'consistent'`. @@ -109,11 +117,13 @@ When configured with `'!'`. ## Install +[npm][]: + ```sh npm install remark-lint-strong-marker ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -150,6 +160,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-strong-marker.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-strong-marker + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-strong-marker.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-strong-marker + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-table-cell-padding/readme.md b/packages/remark-lint-table-cell-padding/readme.md index d7ba8cb7..2cb76fea 100644 --- a/packages/remark-lint-table-cell-padding/readme.md +++ b/packages/remark-lint-table-cell-padding/readme.md @@ -2,6 +2,14 @@ # remark-lint-table-cell-padding +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when table cells are incorrectly padded. Options: `'consistent'`, `'padded'`, or `'compact'`, default: `'consistent'`. @@ -257,11 +265,13 @@ When configured with `'invalid'`. ## Install +[npm][]: + ```sh npm install remark-lint-table-cell-padding ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -298,6 +308,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-table-cell-padding.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-table-cell-padding + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-table-cell-padding.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-table-cell-padding + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-table-pipe-alignment/readme.md b/packages/remark-lint-table-pipe-alignment/readme.md index f14a567f..a3982caf 100644 --- a/packages/remark-lint-table-pipe-alignment/readme.md +++ b/packages/remark-lint-table-pipe-alignment/readme.md @@ -2,6 +2,14 @@ # remark-lint-table-pipe-alignment +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when table pipes are not aligned. ## Fix @@ -66,11 +74,13 @@ No messages. ## Install +[npm][]: + ```sh npm install remark-lint-table-pipe-alignment ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -107,6 +117,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-table-pipe-alignment.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-table-pipe-alignment + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-table-pipe-alignment.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-table-pipe-alignment + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-table-pipes/readme.md b/packages/remark-lint-table-pipes/readme.md index f20aaec3..0d2d3787 100644 --- a/packages/remark-lint-table-pipes/readme.md +++ b/packages/remark-lint-table-pipes/readme.md @@ -2,6 +2,14 @@ # remark-lint-table-pipes +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when table rows are not fenced with pipes. ## Fix @@ -60,11 +68,13 @@ Alpha | Bravo ## Install +[npm][]: + ```sh npm install remark-lint-table-pipes ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -101,6 +111,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-table-pipes.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-table-pipes + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-table-pipes.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-table-pipes + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint-unordered-list-marker-style/readme.md b/packages/remark-lint-unordered-list-marker-style/readme.md index ffe50b00..f27c9a9b 100644 --- a/packages/remark-lint-unordered-list-marker-style/readme.md +++ b/packages/remark-lint-unordered-list-marker-style/readme.md @@ -2,6 +2,14 @@ # remark-lint-unordered-list-marker-style +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + Warn when the list item marker style of unordered lists violate a given style. @@ -125,11 +133,13 @@ When configured with `'!'`. ## Install +[npm][]: + ```sh npm install remark-lint-unordered-list-marker-style ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -166,6 +176,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-lint-unordered-list-marker-style.svg + +[downloads]: https://www.npmjs.com/package/remark-lint-unordered-list-marker-style + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint-unordered-list-marker-style.svg + +[size]: https://bundlephobia.com/result?p=remark-lint-unordered-list-marker-style + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-lint/readme.md b/packages/remark-lint/readme.md index 0bd68a58..69f614b2 100644 --- a/packages/remark-lint/readme.md +++ b/packages/remark-lint/readme.md @@ -3,33 +3,81 @@ [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] -[![Chat][chat-badge]][chat] +[![Size][size-badge]][size] [![Sponsors][sponsors-badge]][collective] [![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] -`remark-lint` is a markdown code style linter built on [**remark**][remark], a -powerful markdown processor powered by [plugins][]. +[**remark**][remark] plugin to lint Markdown code style. -Read more about `remark-lint` on [the monorepo readme][repo]. +Read more about `remark-lint` on [the monorepo readme][readme]. This package doesn’t do much other than [suppressing messages][suppres] through comments. +If you’re using [presets][], they already include `remark-lint` itself. +If you’re using just plugins, you have to include `remark-lint` explicitly. + ## Install +[npm][]: + ```sh npm install remark-lint ``` +## Use + +You probably want to use it on the CLI through a config file: + +```diff + ... + "remarkConfig": { + "plugins": [ + ... ++ "lint", + ... + ] + } + ... +``` + +Or use it on the CLI directly + +```sh +remark -u lint readme.md +``` + +Or use this on the API: + +```diff + var remark = require('remark'); + var report = require('vfile-reporter'); + + remark() ++ .use(require('remark-lint')) + .process('_Emphasis_ and **importance**', function (err, file) { + console.error(report(err || file)); + }); +``` + +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License [MIT][license] © [Titus Wormer][author] - - [logo]: https://raw.githubusercontent.com/remarkjs/remark-lint/02295bc/logo.svg?sanitize=true -[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint.svg +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg [build]: https://travis-ci.org/remarkjs/remark-lint @@ -41,9 +89,9 @@ npm install remark-lint [downloads]: https://www.npmjs.com/package/remark-lint -[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint.svg -[chat]: https://spectrum.chat/unified/remark +[size]: https://bundlephobia.com/result?p=remark-lint [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg @@ -51,14 +99,28 @@ npm install remark-lint [collective]: https://opencollective.com/unified -[repo]: https://github.com/remarkjs/remark-lint#readme +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg -[remark]: https://github.com/remarkjs/remark +[chat]: https://spectrum.chat/unified/remark -[plugins]: https://github.com/remarkjs/remark/blob/master/doc/plugins.md +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md [license]: https://github.com/remarkjs/remark-lint/blob/master/license [author]: https://wooorm.com +[remark]: https://github.com/remarkjs/remark + +[readme]: https://github.com/remarkjs/remark-lint#readme + [suppres]: https://github.com/remarkjs/remark-lint#configuring-remark-lint + +[presets]: https://github.com/remarkjs/remark-lint#list-of-presets diff --git a/packages/remark-preset-lint-consistent/readme.md b/packages/remark-preset-lint-consistent/readme.md index b9fd3e87..ae50a675 100644 --- a/packages/remark-preset-lint-consistent/readme.md +++ b/packages/remark-preset-lint-consistent/readme.md @@ -2,6 +2,14 @@ # remark-preset-lint-consistent +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + remark preset to configure `remark-lint` with settings that enforce consistency. @@ -26,13 +34,13 @@ This preset configures [`remark-lint`](https://github.com/remarkjs/remark-lint) ## Install -npm: +[npm][]: ```sh npm install remark-preset-lint-consistent ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -63,6 +71,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-preset-lint-consistent.svg + +[downloads]: https://www.npmjs.com/package/remark-preset-lint-consistent + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-preset-lint-consistent.svg + +[size]: https://bundlephobia.com/result?p=remark-preset-lint-consistent + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-preset-lint-markdown-style-guide/readme.md b/packages/remark-preset-lint-markdown-style-guide/readme.md index 1b1421db..9c28cfa7 100644 --- a/packages/remark-preset-lint-markdown-style-guide/readme.md +++ b/packages/remark-preset-lint-markdown-style-guide/readme.md @@ -2,6 +2,14 @@ # remark-preset-lint-markdown-style-guide +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + remark preset to configure `remark-lint` with settings that the [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/) recommends. @@ -150,13 +158,13 @@ This preset configures [`remark-lint`](https://github.com/remarkjs/remark-lint) ## Install -npm: +[npm][]: ```sh npm install remark-preset-lint-markdown-style-guide ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -187,6 +195,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-preset-lint-markdown-style-guide.svg + +[downloads]: https://www.npmjs.com/package/remark-preset-lint-markdown-style-guide + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-preset-lint-markdown-style-guide.svg + +[size]: https://bundlephobia.com/result?p=remark-preset-lint-markdown-style-guide + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/remark-preset-lint-recommended/readme.md b/packages/remark-preset-lint-recommended/readme.md index 9729175b..f0528487 100644 --- a/packages/remark-preset-lint-recommended/readme.md +++ b/packages/remark-preset-lint-recommended/readme.md @@ -2,6 +2,14 @@ # remark-preset-lint-recommended +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] + remark preset to configure `remark-lint` with settings that prevent mistakes or syntaxes that do not work correctly across vendors. @@ -29,13 +37,13 @@ This preset configures [`remark-lint`](https://github.com/remarkjs/remark-lint) ## Install -npm: +[npm][]: ```sh npm install remark-preset-lint-recommended ``` -## Usage +## Use You probably want to use it on the CLI through a config file: @@ -66,6 +74,56 @@ Or use this on the API: }); ``` +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT](https://github.com/remarkjs/remark-lint/blob/master/license) © [Titus Wormer](https://wooorm.com) +[MIT][license] © [Titus Wormer][author] + +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/remark-preset-lint-recommended.svg + +[downloads]: https://www.npmjs.com/package/remark-preset-lint-recommended + +[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-preset-lint-recommended.svg + +[size]: https://bundlephobia.com/result?p=remark-preset-lint-recommended + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license + +[author]: https://wooorm.com diff --git a/packages/unified-lint-rule/readme.md b/packages/unified-lint-rule/readme.md index 48d1f7bb..aee0ed8a 100644 --- a/packages/unified-lint-rule/readme.md +++ b/packages/unified-lint-rule/readme.md @@ -1,22 +1,97 @@ # unified-lint-rule -Create a simple linting rule for a unified processors. +[![Build][build-badge]][build] +[![Coverage][coverage-badge]][coverage] +[![Downloads][downloads-badge]][downloads] +[![Size][size-badge]][size] +[![Sponsors][sponsors-badge]][collective] +[![Backers][backers-badge]][collective] +[![Chat][chat-badge]][chat] -Each rule in `remark-lint` uses this project. See [`remark-lint`][lint] for -examples! +[**unified**][unified] plugin to make it a bit easier to create linting rules. + +Each rule in [`remark-lint`][lint] uses this project, so see that for examples! ## Install +[npm][]: + ```sh npm install unified-lint-rule ``` +## Use + +```js +var rule = require('unified-lint-rule') + +module.exports = rule('remark-lint:file-extension', fileExtension) + +function fileExtension(tree, file, pref) { + var ext = file.extname + + pref = typeof pref === 'string' ? pref : 'md' + + if (ext && ext.slice(1) !== pref) { + file.message('Invalid extension: use `' + pref + '`') + } +} +``` + +## Contribute + +See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways +to get started. +See [`support.md`][support] for ways to get help. + +This project has a [Code of Conduct][coc]. +By interacting with this repository, organisation, or community you agree to +abide by its terms. + ## License -[MIT][] © [Titus Wormer][author] +[MIT][license] © [Titus Wormer][author] -[lint]: https://github.com/remarkjs/remark-lint +[build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg + +[build]: https://travis-ci.org/remarkjs/remark-lint + +[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg + +[coverage]: https://codecov.io/github/remarkjs/remark-lint + +[downloads-badge]: https://img.shields.io/npm/dm/unified-lint-rule.svg -[mit]: https://github.com/remarkjs/remark-lint/blob/master/license +[downloads]: https://www.npmjs.com/package/unified-lint-rule + +[size-badge]: https://img.shields.io/bundlephobia/minzip/unified-lint-rule.svg + +[size]: https://bundlephobia.com/result?p=unified-lint-rule + +[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg + +[backers-badge]: https://opencollective.com/unified/backers/badge.svg + +[collective]: https://opencollective.com/unified + +[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg + +[chat]: https://spectrum.chat/unified/remark + +[npm]: https://docs.npmjs.com/cli/install + +[health]: https://github.com/remarkjs/.github + +[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md + +[support]: https://github.com/remarkjs/.github/blob/master/support.md + +[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md + +[license]: https://github.com/remarkjs/remark-lint/blob/master/license [author]: https://wooorm.com + +[unified]: https://github.com/unifiedjs/unified + +[lint]: https://github.com/remarkjs/remark-lint diff --git a/script/build-presets.js b/script/build-presets.js index 531d85b5..57065bfa 100644 --- a/script/build-presets.js +++ b/script/build-presets.js @@ -25,6 +25,17 @@ presets(root).forEach(function(basename) { var rows = [] var children var short = basename.replace(/^remark-/, '') + var org = remote + .split('/') + .slice(0, -1) + .join('/') + var master = remote + '/blob/master' + var health = org + '/.github' + var hMaster = health + '/blob/master' + var slug = remote + .split('/') + .slice(-2) + .join('/') if (basename !== pack.name) { throw new Error( @@ -65,7 +76,36 @@ presets(root).forEach(function(basename) { children = [ u('html', ''), - u('heading', {depth: 1}, [u('text', basename)]) + u('heading', {depth: 1}, [u('text', basename)]), + u('paragraph', [ + u('linkReference', {identifier: 'build'}, [ + u('imageReference', {identifier: 'build-badge', alt: 'Build'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'coverage'}, [ + u('imageReference', {identifier: 'coverage-badge', alt: 'Coverage'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'downloads'}, [ + u('imageReference', {identifier: 'downloads-badge', alt: 'Downloads'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'size'}, [ + u('imageReference', {identifier: 'size-badge', alt: 'Size'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'collective'}, [ + u('imageReference', {identifier: 'sponsors-badge', alt: 'Sponsors'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'collective'}, [ + u('imageReference', {identifier: 'backers-badge', alt: 'Backers'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'chat'}, [ + u('imageReference', {identifier: 'chat-badge', alt: 'Chat'}) + ]) + ]) ] children = children.concat(remark().parse(description).children) @@ -79,9 +119,14 @@ presets(root).forEach(function(basename) { ]), u('table', {align: []}, rows), u('heading', {depth: 2}, [u('text', 'Install')]), - u('paragraph', [u('text', 'npm:')]), + u('paragraph', [ + u('linkReference', {identifier: 'npm', referenceType: 'collapsed'}, [ + u('text', 'npm') + ]), + u('text', ':') + ]), u('code', {lang: 'sh'}, 'npm install ' + basename), - u('heading', {depth: 2}, [u('text', 'Usage')]), + u('heading', {depth: 2}, [u('text', 'Use')]), u('paragraph', [ u('text', 'You probably want to use it on the CLI through a config file:') ]), @@ -113,14 +158,111 @@ presets(root).forEach(function(basename) { ' });' ].join('\n') ), - u('heading', {depth: 2}, [u('text', 'License')]), + u('heading', {depth: 2}, [u('text', 'Contribute')]), u('paragraph', [ - u('link', {url: remote + '/blob/master/license'}, [ - u('text', pack.license) + u('text', 'See '), + u('linkReference', {identifier: 'contributing'}, [ + u('inlineCode', 'contributing.md') + ]), + u('text', ' in '), + u('linkReference', {identifier: 'health'}, [ + u( + 'inlineCode', + health + .split('/') + .slice(-2) + .join('/') + ) ]), + u('text', ' for ways\nto get started.\nSee '), + u('linkReference', {identifier: 'support'}, [ + u('inlineCode', 'support.md') + ]), + u('text', ' for ways to get help.') + ]), + u('paragraph', [ + u('text', 'This project has a '), + u('linkReference', {identifier: 'coc'}, [u('text', 'Code of Conduct')]), + u( + 'text', + '.\nBy interacting with this repository, organisation, or community you agree to\nabide by its terms.' + ) + ]), + u('heading', {depth: 2}, [u('text', 'License')]), + u('paragraph', [ + u('linkReference', {identifier: 'license'}, [u('text', pack.license)]), u('text', ' © '), - u('link', {url: author.url}, [u('text', author.name)]) - ]) + u('linkReference', {identifier: 'author'}, [u('text', author.name)]) + ]), + u('definition', { + identifier: 'build-badge', + url: 'https://img.shields.io/travis/' + slug + '/master.svg' + }), + u('definition', { + identifier: 'build', + url: 'https://travis-ci.org/' + slug + }), + u('definition', { + identifier: 'coverage-badge', + url: 'https://img.shields.io/codecov/c/github/' + slug + '.svg' + }), + u('definition', { + identifier: 'coverage', + url: 'https://codecov.io/github/' + slug + }), + u('definition', { + identifier: 'downloads-badge', + url: 'https://img.shields.io/npm/dm/' + basename + '.svg' + }), + u('definition', { + identifier: 'downloads', + url: 'https://www.npmjs.com/package/' + basename + }), + u('definition', { + identifier: 'size-badge', + url: 'https://img.shields.io/bundlephobia/minzip/' + basename + '.svg' + }), + u('definition', { + identifier: 'size', + url: 'https://bundlephobia.com/result?p=' + basename + }), + u('definition', { + identifier: 'sponsors-badge', + url: 'https://opencollective.com/unified/sponsors/badge.svg' + }), + u('definition', { + identifier: 'backers-badge', + url: 'https://opencollective.com/unified/backers/badge.svg' + }), + u('definition', { + identifier: 'collective', + url: 'https://opencollective.com/unified' + }), + u('definition', { + identifier: 'chat-badge', + url: + 'https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg' + }), + u('definition', { + identifier: 'chat', + url: 'https://spectrum.chat/unified/remark' + }), + u('definition', { + identifier: 'npm', + url: 'https://docs.npmjs.com/cli/install' + }), + u('definition', {identifier: 'health', url: health}), + u('definition', { + identifier: 'contributing', + url: hMaster + '/contributing.md' + }), + u('definition', {identifier: 'support', url: hMaster + '/support.md'}), + u('definition', { + identifier: 'coc', + url: hMaster + '/code-of-conduct.md' + }), + u('definition', {identifier: 'license', url: master + '/license'}), + u('definition', {identifier: 'author', url: author.url}) ) fs.writeFileSync( diff --git a/script/build-rules.js b/script/build-rules.js index ff03feea..88d2d1dd 100644 --- a/script/build-rules.js +++ b/script/build-rules.js @@ -41,18 +41,57 @@ rules(root).forEach(function(basename) { var tests = info.tests var author = parseAuthor(pack.author) var short = basename.replace(/^remark-/, '') + var org = remote + .split('/') + .slice(0, -1) + .join('/') + var master = remote + '/blob/master' + var health = org + '/.github' + var hMaster = health + '/blob/master' + var slug = remote + .split('/') + .slice(-2) + .join('/') var includes var children = [ u('html', ''), - u('heading', {depth: 1}, [u('text', basename)]) + u('heading', {depth: 1}, [u('text', basename)]), + u('paragraph', [ + u('linkReference', {identifier: 'build'}, [ + u('imageReference', {identifier: 'build-badge', alt: 'Build'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'coverage'}, [ + u('imageReference', {identifier: 'coverage-badge', alt: 'Coverage'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'downloads'}, [ + u('imageReference', {identifier: 'downloads-badge', alt: 'Downloads'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'size'}, [ + u('imageReference', {identifier: 'size-badge', alt: 'Size'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'collective'}, [ + u('imageReference', {identifier: 'sponsors-badge', alt: 'Sponsors'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'collective'}, [ + u('imageReference', {identifier: 'backers-badge', alt: 'Backers'}) + ]), + u('text', '\n'), + u('linkReference', {identifier: 'chat'}, [ + u('imageReference', {identifier: 'chat-badge', alt: 'Chat'}) + ]) + ]) ].concat(remark().parse(info.description).children) if (basename !== pack.name) { throw new Error( 'Expected package name (`' + pack.name + - '`) to be the same as ' + - 'directory name (`' + + '`) to be the same as directory name (`' + basename + '`)' ) @@ -160,8 +199,14 @@ rules(root).forEach(function(basename) { children = children.concat([ u('heading', {depth: 2}, [u('text', 'Install')]), + u('paragraph', [ + u('linkReference', {identifier: 'npm', referenceType: 'collapsed'}, [ + u('text', 'npm') + ]), + u('text', ':') + ]), u('code', {lang: 'sh'}, 'npm install ' + basename), - u('heading', {depth: 2}, [u('text', 'Usage')]), + u('heading', {depth: 2}, [u('text', 'Use')]), u('paragraph', [ u('text', 'You probably want to use it on the CLI through a config file:') ]), @@ -199,14 +244,111 @@ rules(root).forEach(function(basename) { ' });' ].join('\n') ), - u('heading', {depth: 2}, [u('text', 'License')]), + u('heading', {depth: 2}, [u('text', 'Contribute')]), u('paragraph', [ - u('link', {url: remote + '/blob/master/license'}, [ - u('text', pack.license) + u('text', 'See '), + u('linkReference', {identifier: 'contributing'}, [ + u('inlineCode', 'contributing.md') ]), + u('text', ' in '), + u('linkReference', {identifier: 'health'}, [ + u( + 'inlineCode', + health + .split('/') + .slice(-2) + .join('/') + ) + ]), + u('text', ' for ways\nto get started.\nSee '), + u('linkReference', {identifier: 'support'}, [ + u('inlineCode', 'support.md') + ]), + u('text', ' for ways to get help.') + ]), + u('paragraph', [ + u('text', 'This project has a '), + u('linkReference', {identifier: 'coc'}, [u('text', 'Code of Conduct')]), + u( + 'text', + '.\nBy interacting with this repository, organisation, or community you agree to\nabide by its terms.' + ) + ]), + u('heading', {depth: 2}, [u('text', 'License')]), + u('paragraph', [ + u('linkReference', {identifier: 'license'}, [u('text', pack.license)]), u('text', ' © '), - u('link', {url: author.url}, [u('text', author.name)]) - ]) + u('linkReference', {identifier: 'author'}, [u('text', author.name)]) + ]), + u('definition', { + identifier: 'build-badge', + url: 'https://img.shields.io/travis/' + slug + '/master.svg' + }), + u('definition', { + identifier: 'build', + url: 'https://travis-ci.org/' + slug + }), + u('definition', { + identifier: 'coverage-badge', + url: 'https://img.shields.io/codecov/c/github/' + slug + '.svg' + }), + u('definition', { + identifier: 'coverage', + url: 'https://codecov.io/github/' + slug + }), + u('definition', { + identifier: 'downloads-badge', + url: 'https://img.shields.io/npm/dm/' + basename + '.svg' + }), + u('definition', { + identifier: 'downloads', + url: 'https://www.npmjs.com/package/' + basename + }), + u('definition', { + identifier: 'size-badge', + url: 'https://img.shields.io/bundlephobia/minzip/' + basename + '.svg' + }), + u('definition', { + identifier: 'size', + url: 'https://bundlephobia.com/result?p=' + basename + }), + u('definition', { + identifier: 'sponsors-badge', + url: 'https://opencollective.com/unified/sponsors/badge.svg' + }), + u('definition', { + identifier: 'backers-badge', + url: 'https://opencollective.com/unified/backers/badge.svg' + }), + u('definition', { + identifier: 'collective', + url: 'https://opencollective.com/unified' + }), + u('definition', { + identifier: 'chat-badge', + url: + 'https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg' + }), + u('definition', { + identifier: 'chat', + url: 'https://spectrum.chat/unified/remark' + }), + u('definition', { + identifier: 'npm', + url: 'https://docs.npmjs.com/cli/install' + }), + u('definition', {identifier: 'health', url: health}), + u('definition', { + identifier: 'contributing', + url: hMaster + '/contributing.md' + }), + u('definition', {identifier: 'support', url: hMaster + '/support.md'}), + u('definition', { + identifier: 'coc', + url: hMaster + '/code-of-conduct.md' + }), + u('definition', {identifier: 'license', url: master + '/license'}), + u('definition', {identifier: 'author', url: author.url}) ]) fs.writeFileSync(