Skip to content

Commit 4a6ed22

Browse files
committed
feat(website): update documentation structure for alternative parser guides
1 parent 4e9a298 commit 4a6ed22

File tree

9 files changed

+45
-11
lines changed

9 files changed

+45
-11
lines changed

website/app/overrides.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
#nd-docs-layout #nd-sidebar a {
2+
margin-top: 0.375rem;
3+
margin-bottom: 0.375rem;
4+
}
5+
16
#nd-docs-layout #nd-sidebar a[data-active] {
27
font-weight: 400;
38
}

website/content/docs/configurations.mdx

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,26 @@
22
title: Configurations
33
---
44

5-
import { ConfigurationsTypeTable } from "./configurations"
5+
import { SettingsTypeTable } from "./configurations";
66

7-
ESLint React provides the following configurations:
7+
A [configuration object](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-objects) is used to configure the behavior of the rules in ESLint React. You can define the settings object in the `settings["react-x"]` field of your ESLint configuration file.
8+
9+
```ts title="eslint.config.js"
10+
export default [
11+
{
12+
files: ["**/*.ts", "**/*.tsx"],
13+
settings: {
14+
"react-x": {
15+
version: "19.0.0",
16+
},
17+
},
18+
},
19+
];
20+
```
821

922
## Properties
1023

11-
<ConfigurationsTypeTable />
24+
<SettingsTypeTable />
1225

1326
## Descriptions
1427

website/content/docs/configurations.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { DynamicCodeBlock } from "fumadocs-ui/components/dynamic-codeblock";
44
import { TypeTable } from "fumadocs-ui/components/type-table";
55
import { Link } from "next-view-transitions";
66

7-
export function ConfigurationsTypeTable() {
7+
export function SettingsTypeTable() {
88
return (
99
<TypeTable
1010
type={{

website/content/docs/getting-started/meta.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
"title": "Getting Started",
33
"pages": [
44
"javascript",
5-
"javascript-with-alternative-parser",
6-
"typescript",
7-
"typescript-with-alternative-parser"
5+
"typescript"
86
],
97
"defaultOpen": true
108
}

website/content/docs/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"rules",
77
"presets",
88
"configurations",
9+
"using-an-alternative-parser",
910
"!advanced-configuration",
1011
"---Other---",
1112
"faq",

website/content/docs/getting-started/javascript-with-alternative-parser.mdx renamed to website/content/docs/using-an-alternative-parser/babel-eslint-parser.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: JavaScript with alternative parser
3-
description: Getting started with JavaScript + Babel ESLint Parser setup
2+
title: "@babel/eslint-parser"
3+
description: "Using @babel/eslint-parser as an alternative parser for JavaScript projects"
44
---
55

66
## Install
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"title": "Using an alternative parser",
3+
"pages": [
4+
"babel-eslint-parser",
5+
"ts-blank-eslint-parser"
6+
]
7+
}

website/content/docs/getting-started/typescript-with-alternative-parser.mdx renamed to website/content/docs/using-an-alternative-parser/ts-blank-eslint-parser.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: TypeScript with alternative parser
3-
description: Getting started with TypeScript + TS Blank ESLint Parser setup
2+
title: "ts-blank-eslint-parser"
3+
description: "Using ts-blank-eslint-parser as an alternative parser for TypeScript projects"
44
---
55

66
<Callout type="warn">

website/next.config.mjs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ const config = {
2222
destination: "/docs/getting-started/javascript",
2323
permanent: true,
2424
},
25+
{
26+
source: "/docs/getting-started/javascript-with-alternative-parser",
27+
destination: "/docs/using-an-alternative-parser/babel-eslint-parser",
28+
permanent: true,
29+
},
30+
{
31+
source: "/docs/getting-started/typescript-with-alternative-parser",
32+
destination: "/docs/using-an-alternative-parser/ts-blank-eslint-parser",
33+
permanent: true,
34+
},
2535
{
2636
source: "/docs/rules",
2737
destination: "/docs/rules/overview",

0 commit comments

Comments
 (0)