Skip to content

Commit

Permalink
chore(playground):update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AVGVSTVS96 committed Aug 5, 2024
1 parent a3fe3ad commit 936f41b
Showing 1 changed file with 6 additions and 27 deletions.
33 changes: 6 additions & 27 deletions playground/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,9 @@
# React + TypeScript + Vite
# react-shiki-examples

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

Currently, two official plugins are available:
## Run Playground

- [@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
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

## Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

- Configure the top-level `parserOptions` property like this:

```js
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json', './tsconfig.app.json'],
tsconfigRootDir: __dirname,
},
}
```

- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- 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
```bash
[pnpm|yarn|bun|npm] run playground:dev
```

0 comments on commit 936f41b

Please sign in to comment.