sveltejs / eslint-plugin-svelte

ESLint plugin for Svelte using AST
https://sveltejs.github.io/eslint-plugin-svelte/
MIT License
308 stars 37 forks source link

Publishing docs on svelte.dev or highlighting them there #824

Open benmccann opened 4 months ago

benmccann commented 4 months ago

Description

We're starting to put together plans to publish docs for all the various plugins directly on svelte.dev (e.g. vite-plugin-svelte, rollup-plugin-svelte, svelte-loader, svelte-preprocess, the VS code plugin, prettier-plugin-svelte, eslint-plugin-svelte, etc.)

eslint-plugin-svelte is much different than the others because it has many more pages as well as an existing site and a playground. This raises several questions:

I've asked these questions of the other maintainers working on the site, but thought it would be good to get your input as well. We'd like to try to have the markdown continue to live in each individual repository and then the site's build and deploy process will check out each of those repositories and use the docs from there. We're working on prototyping that right now. The main change needed here would probably be to publish a bit of config stating what order the pages should show up in the sidebar (e.g. https://github.com/sveltejs/svelte/pull/12410)

ota-meshi commented 4 months ago

Thank you for letting me know.

Or should move all the content over except for the playground?

I like this option :+1:

I want to show red markers in the documentation for each rule, so do you think we can introduce twoslash-eslint instead of rule playground? You can see a working example of twoslash-eslint at the following site: https://eslint.style/rules/default/array-bracket-newline#always

I think the plugin playground could be directed to another site.

https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript