https://github.com/levchak0910/slidev-addon-eslint-editor-vue
Slidev addon that add eslint vue editor component
https://github.com/levchak0910/slidev-addon-eslint-editor-vue
eslint slidev slidev-addon vue
Last synced: 2 months ago
JSON representation
Slidev addon that add eslint vue editor component
- Host: GitHub
- URL: https://github.com/levchak0910/slidev-addon-eslint-editor-vue
- Owner: levchak0910
- Created: 2024-03-12T18:22:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T16:40:05.000Z (about 1 year ago)
- Last Synced: 2025-02-01T16:48:47.264Z (4 months ago)
- Topics: eslint, slidev, slidev-addon, vue
- Language: Vue
- Homepage: https://levchak0910.github.io/slidev-addon-eslint-editor-vue/
- Size: 504 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ESLint Vue Editor for Slidev
Addon for [Slidev](https://sli.dev/) (Presentation Slides for Developers)
Based on [eslint-editor-vue](https://github.com/ota-meshi/site-kit/tree/main/packages/site-kit-eslint-editor-vue) from [@ota-meshi](https://github.com/ota-meshi)
## Usage
### Install
```bash
npm i slidev-addon-eslint-editor-vue
```
```bash
yarn add slidev-addon-eslint-editor-vue
```
```bash
pnpm add slidev-addon-eslint-editor-vue
```
### Slidev Configuration
Define addon in your slidev addons.
In your slides metadata (using Front Matter):
```md
---
addons:
- slidev-addon-eslint-editor-vue
---
```
### Vite configuration
```js
// vite.config.js
import { defineConfig, mergeConfig } from "vite"
import eevConfig from "slidev-addon-eslint-editor-vue/vite.config"
const config = defineConfig({
// your config
})
export default mergeConfig(config, eevConfig)
```
### Use in slides
Usually as any component.
- Can pass code as a code-block.
````md
```vue
Hello
```
````
- Can pass code as a snippet.
```md
<<< @/snippets/code.vue
```
## (Currently) Supported plugins
- [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue)
- [eslint-plugin-vue-scoped-css](https://github.com/future-architect/eslint-plugin-vue-scoped-css)
- [@vkcn/eslint-plugin](https://github.com/levchak0910/vkcn-eslint-plugin)
Need another plugin? Add [your](./components/ESLintVueEditor.vue#L176)