Skip to content

Commit bf88c06

Browse files
committed
docs: improve presets page
1 parent f1675c4 commit bf88c06

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

website/pages/docs/presets.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@ The following presets are available in `@eslint-react/eslint-plugin`:
1313
These presets are for ESLint Flat Config (`eslint.config.js`) only.
1414
</Info>
1515

16-
- **core**\
17-
Enable rules that are renderer-agnostic.
18-
- **dom**\
16+
- Core (`core`)\
17+
Enable basic rules for React itself.
18+
- DOM (`dom`)\
1919
Enable rules that are specific to React DOM.
20-
- **web-api**\
20+
- Web API (`web-api`)\
2121
Enable rules for interacting with Web APIs.
22-
- **recommended**\
22+
- **Recommended** (`recommended`)\
2323
Enable rules that are recommended by ESLint React.\
2424
_This preset includes the `core`, `dom`, and `web-api` presets._
25-
- **recommended-typescript**\
25+
- **Recommended TypeScript** (`recommended-typescript`)\
2626
Enable rules that are recommended by ESLint React and disable rules that can be covered by TypeScript.\
2727
_This preset includes the `recommended` preset._
28-
- **recommended-type-checked**\
28+
- **Recommended Type-Checked** (`recommended-type-checked`)\
2929
Enable rules that are recommended by ESLint React with additional rules that require type information.\
3030
_This preset includes the `recommended-typescript` preset._
31-
- **disable-dom**\
32-
Disable rules that are specific to React DOM.
33-
- **disable-web-api**\
34-
Disable rules for interacting with Web APIs.
35-
- **disable-type-checked**\
31+
- Disable DOM (`disable-dom`)\
32+
Disable rules in the `dom` preset.
33+
- Disable Web API (`disable-web-api`)\
34+
Disable rules in the `web-api` preset.
35+
- Disable Type-Checked (`disable-type-checked`)\
3636
Disable rules that require type information.
37-
- **off**\
37+
- Off (`off`)\
3838
Disable all rules in this plugin except for debug rules.
3939

4040
</Config>
@@ -43,28 +43,28 @@ The following presets are available in `@eslint-react/eslint-plugin`:
4343

4444
<Info>These presets are for ESLint Legacy Config (`.eslintrc.*`) only.</Info>
4545

46-
- **core-legacy**\
47-
Enable rules that are renderer-agnostic.
48-
- **dom-legacy**\
46+
- Core (`core-legacy`)\
47+
Enable basic rules for React itself.
48+
- DOM (`dom-legacy`)\
4949
Enable rules that are specific to React DOM.
50-
- **web-api-legacy**\
50+
- Web API (`web-api-legacy`)\
5151
Enable rules for interacting with Web APIs.
52-
- **recommended-legacy**\
52+
- **Recommended** (`recommended-legacy`)\
5353
Enable rules that are recommended by ESLint React.\
5454
_This preset includes the `core-legacy`, `dom-legacy`, and `web-api-legacy` presets._
55-
- **recommended-typescript-legacy**\
55+
- **Recommended TypeScript** (`recommended-typescript-legacy`)\
5656
Enable rules that are recommended by ESLint React and disable rules that can be covered by TypeScript.\
5757
_This preset includes the `recommended-legacy` preset._
58-
- **recommended-type-checked-legacy**\
58+
- **Recommended Type-Checked** (`recommended-type-checked-legacy`)\
5959
Enable rules that are recommended by ESLint React with additional rules that require type information.\
6060
_This preset includes the `recommended-typescript-legacy` preset._
61-
- **disable-dom-legacy**\
62-
Disable rules that are specific to React DOM.
63-
- **disable-web-api-legacy**\
64-
Disable rules for interacting with Web APIs.
65-
- **disable-type-checked-legacy**\
61+
- Disable DOM (`disable-dom-legacy`)\
62+
Disable rules in the `dom-legacy` preset.
63+
- Disable Web API (`disable-web-api-legacy`)\
64+
Disable rules in the `web-api-legacy` preset.
65+
- Disable Type-Checked (`disable-type-checked-legacy`)\
6666
Disable rules that require type information.
67-
- **off-legacy**\
67+
- Off (`off-legacy`)\
6868
Disable all rules in this plugin except for debug rules.
6969

7070
</Config>

website/styles/overrides.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
}
5454

5555
table {
56+
5657
thead tr th code,
5758
tbody tr td code {
5859
font-family: var(--font-family-mono);

0 commit comments

Comments
 (0)