Skip to content

Commit e2a3fbf

Browse files
committed
chore(playground):update readme
1 parent 1e638bc commit e2a3fbf

File tree

1 file changed

+6
-27
lines changed

1 file changed

+6
-27
lines changed

playground/README.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,9 @@
1-
# React + TypeScript + Vite
1+
# react-shiki-examples
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
See [package/readme](../package/README.md) for more information about `react-shiki`
44

5-
Currently, two official plugins are available:
5+
## Run Playground
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13-
14-
- Configure the top-level `parserOptions` property like this:
15-
16-
```js
17-
export default {
18-
// other rules...
19-
parserOptions: {
20-
ecmaVersion: 'latest',
21-
sourceType: 'module',
22-
project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
23-
tsconfigRootDir: __dirname,
24-
},
25-
}
26-
```
27-
28-
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
29-
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
30-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
7+
```bash
8+
[pnpm|yarn|bun|npm] run playground:dev
9+
```

0 commit comments

Comments
 (0)