pngwn / MDsveX

A markdown preprocessor for Svelte.
https://mdsvex.pngwn.io
MIT License
2.34k stars 101 forks source link

docz equivalent for svelte #97

Open techniq opened 4 years ago

techniq commented 4 years ago

Hi @pngwn 👋 ,

This is more of a question, but have you considered adding additional components to MDsveX to support documenting components easier, similar to the React/Gatsby based docz which has Playground and Props components.

I believe their interactive Playground is based on react-live. I know the svelte-repl is available but I've struggled to get it setup. There is also svelte-simple-repl which looks closer to the use case, and even mention it was started due to svelte-repl difficulties, but it hasn't had much activity in a while. Lastly there is svelte-docs which looks to have its own markdown/svelte parser/compiler, and does start to get closer to docz, although their examples are not editable.

Anyways, I was curious if you thought MDsveX would head in this direction. Thanks

pngwn commented 4 years ago

This sort of thing is one of the motivations for this project, whether I will get around to it myself is hard to say. I do have some plans for higher level tooling around mdsvex when I'm happy with the state of the core library itself.

mdsvex will never become docz et al, in the same way that mdx is just the primitive that many of those libraries use but something like that isn't out the question. You may be interested in @rixo's svench which is a storybook-style component development workbench.