[Docs] Add markdownlint for documentation formatting consistency

Author: bmish

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "line-length": false,
+  "no-inline-html": false,
+  "no-hard-tabs": { "spaces_per_tab": 2 },
+  "ul-style": { "style": "dash" }
+}

.markdownlintignore

@@ -0,0 +1,3 @@
+CHANGELOG.md
+LICENSE
+node_modules

CHANGELOG.md

@@ -40,7 +40,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
 * [Docs] Consistent rule descriptions and doc sections ([#3361][] @bmish)
 * [Docs] Standardize deprecated rule notice ([#3364][] @bmish)
 * [Docs] Fix typos ([#3366][] @bmish)
+* [Docs] Add markdownlint for documentation formatting consistency ([#3367][] @bmish)
 
+[#3367]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3367
 [#3366]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3366
 [#3365]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3365
 [#3364]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3364

README.md

@@ -1,4 +1,5 @@
 # `eslint-plugin-react` <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
 ===================
 
 [![github actions][actions-image]][actions-url]
@@ -8,16 +9,15 @@
 
 React specific linting rules for `eslint`
 
-# Installation
+## Installation
 
 ```sh
-$ npm install eslint eslint-plugin-react --save-dev
+npm install eslint eslint-plugin-react --save-dev
 ```
 
 It is also possible to install ESLint globally rather than locally (using npm install eslint --global). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.
 
-# Configuration
-
+## Configuration
 
 Use [our preset](#recommended) to get reasonable defaults:
 
@@ -109,7 +109,7 @@ Enable the rules that you would like to use.
   }
 ```
 
-# List of supported rules
+## List of supported rules
 
 ✔: Enabled in the [`recommended`](#recommended) configuration.\
 🔧: Fixable with [`eslint --fix`](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems).\
@@ -179,7 +179,7 @@ Enable the rules that you would like to use.
 |  |  |  | [react/void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md) | Disallow void DOM elements (e.g. `<img />`, `<br />`) from receiving children |
 <!-- AUTO-GENERATED-CONTENT:END -->
 
-## JSX-specific rules
+### JSX-specific rules
 
 <!-- AUTO-GENERATED-CONTENT:START (JSX_RULES) -->
 | ✔ | 🔧 | 💡 | Rule | Description |
@@ -225,15 +225,15 @@ Enable the rules that you would like to use.
 |  | 🔧 |  | [react/jsx-wrap-multilines](docs/rules/jsx-wrap-multilines.md) | Disallow missing parentheses around multiline JSX |
 <!-- AUTO-GENERATED-CONTENT:END -->
 
-## Other useful plugins
+### Other useful plugins
 
 - Rules of Hooks: [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/master/packages/eslint-plugin-react-hooks)
 - JSX accessibility: [eslint-plugin-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)
 - React Native: [eslint-plugin-react-native](https://github.com/Intellicode/eslint-plugin-react-native)
 
-# Shareable configurations
+## Shareable configurations
 
-## Recommended
+### Recommended
 
 This plugin exports a `recommended` configuration that enforces React good practices.
 
@@ -247,7 +247,7 @@ To enable this configuration use the `extends` property in your `.eslintrc` conf
 
 See [`eslint` documentation](https://eslint.org/docs/user-guide/configuring/configuration-files#extending-configuration-files) for more information about extending configuration files.
 
-## All
+### All
 
 This plugin also exports an `all` configuration that includes every available rule.
 This pairs well with the `eslint:all` rule.
@@ -263,11 +263,10 @@ This pairs well with the `eslint:all` rule.
 
 **Note**: These configurations will import `eslint-plugin-react` and enable JSX in [parser options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options).
 
-# License
+## License
 
 `eslint-plugin-react` is licensed under the [MIT License](https://opensource.org/licenses/mit-license.php).
 
-
 [npm-url]: https://npmjs.org/package/eslint-plugin-react
 [npm-image]: https://img.shields.io/npm/v/eslint-plugin-react.svg
 

SECURITY.md

@@ -9,7 +9,6 @@ This is the list of versions of `eslint-plugin-react` which are currently being
 | 7.x      | :white_check_mark: |
 | < 7.x    | :x:                |
 
-
 ## Reporting a Vulnerability
 
 To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.

docs/rules/boolean-prop-naming.md

@@ -36,6 +36,7 @@ var Hello = createReactClass({
   render: function() { return <div />; };
 });
 ```
+
 ```jsx
 type Props = {
   isEnabled: boolean
@@ -94,8 +95,8 @@ The custom message to display upon failure to match the rule. This overrides the
 
 If you choose to use a custom message, you have access to two template variables.
 
-* `propName` – the name of the prop that does not match the pattern
-* `pattern` – the pattern against which all prop names are tested
+- `propName` – the name of the prop that does not match the pattern
+- `pattern` – the pattern against which all prop names are tested
 
 For example, if a prop is named `something`, and if the rule's pattern is set to `"^(is|has)[A-Z]([A-Za-z0-9]?)+"`, you could set the custom message as follows:
 
@@ -105,7 +106,7 @@ message: 'It is better if your prop ({{ propName }}) matches this pattern: ({{ p
 
 And the failure would look like so:
 
-```
+```plaintext
 It is better if your prop (something) matches this pattern: (^is[A-Z]([A-Za-z0-9]?)+)
 ```
 

docs/rules/default-props-match-prop-types.md

@@ -192,7 +192,7 @@ If you don't care about stray `defaultsProps` in your components, you can disabl
 
 - [require-default-props](./require-default-props.md)
 
-# Resources
+## Resources
 
 - [Official React documentation on defaultProps](https://facebook.github.io/react/docs/typechecking-with-proptypes.html#default-prop-values)
 

docs/rules/destructuring-assignment.md

@@ -3,6 +3,7 @@
 🔧 This rule is automatically fixable using the `--fix` [flag](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) on the command line.
 
 Rule can be set to either of `always` or `never`;
+
 ```js
 "react/destructuring-assignment": [<enabled>, 'always']
 ```

docs/rules/display-name.md

@@ -130,6 +130,6 @@ For this rule to work we need to detect React components, this could be very har
 
 For now we should detect components created with:
 
-* `createReactClass()`
-* an ES6 class that inherit from `React.Component` or `Component`
-* a stateless function that return JSX or the result of a `React.createElement` call.
+- `createReactClass()`
+- an ES6 class that inherit from `React.Component` or `Component`
+- a stateless function that return JSX or the result of a `React.createElement` call.

docs/rules/forbid-elements.md

@@ -18,8 +18,8 @@ This rule checks all JSX elements and `React.createElement` calls and verifies t
 
 An array of strings and/or objects. An object in this array may have the following properties:
 
-* `element` (required): the name of the forbidden element (e.g. `'button'`, `'Modal'`)
-* `message`: additional message that gets reported
+- `element` (required): the name of the forbidden element (e.g. `'button'`, `'Modal'`)
+- `message`: additional message that gets reported
 
 A string item in the array is a shorthand for `{ element: string }`.