Skip to content

Commit 6b8b9f7

Browse files
committed
Docs: add toc in readme
1 parent 07cd9c9 commit 6b8b9f7

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,19 @@
22

33
An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and TypeScript are all supported.
44

5-
## Installation
5+
<!-- vscode-markdown-toc -->
6+
* [Installation](#Installation)
7+
* [Usage](#Usage)
8+
* [Supported Rules](#SupportedRules)
9+
* [Supported Presets](#SupportedPresets)
10+
11+
<!-- vscode-markdown-toc-config
12+
numbering=false
13+
autoSave=true
14+
/vscode-markdown-toc-config -->
15+
<!-- /vscode-markdown-toc -->s
16+
17+
## <a name='Installation'></a>Installation
618

719
You'll first need to install [ESLint](https://eslint.org):
820

@@ -16,7 +28,7 @@ Next, install `eslint-plugin-eslint-plugin`:
1628
npm install eslint-plugin-eslint-plugin --save-dev
1729
```
1830

19-
## Usage
31+
## <a name='Usage'></a>Usage
2032

2133
Add `eslint-plugin` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
2234

@@ -38,7 +50,7 @@ Then configure the rules you want to use under the rules section.
3850
}
3951
```
4052

41-
## Supported Rules
53+
## <a name='SupportedRules'></a>Supported Rules
4254

4355
* ✔️ if the rule belongs to the `recommended` configuration
4456
* 🛠 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
@@ -73,7 +85,7 @@ Name | ✔️ | 🛠 | 💡 | Description
7385
[test-case-shorthand-strings](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-shorthand-strings.md) | | 🛠 | | enforce consistent usage of shorthand strings for test cases with no options
7486
<!-- __END AUTOGENERATED TABLE__ -->
7587

76-
## Supported Presets
88+
## <a name='SupportedPresets'></a>Supported Presets
7789

7890
| | Name | Description |
7991
|:--|:-----|:------------|

0 commit comments

Comments
 (0)