*.story.md is not rendering properly with Sveltekit

[swyxio]

Describe the bug

was trying out the docs files feature... but add a .story.md file in svelte, and this happens

for component:

for "virtual story":

Reproduction

• PR: add basic Histoire setup for design system/component kit swyxio/swyxkit#113
• Github branch: https://github.com/sw-yx/swyxkit/blob/addHistoire/src/components/Introduction.story.md
• deployed: https://histoire-build-bug-demo.netlify.app/story/src-components-featurecard-story-svelte?variantId=src-components-featurecard-story-svelte-2&tab=docs

System Info

System:
    OS: macOS 12.5.1
    CPU: (10) arm64 Apple M1 Max
    Memory: 772.11 MB / 32.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 16.15.0 - ~/Library/Caches/fnm_multishells/35700_1665020132817/bin/node
    Yarn: 1.22.19 - /opt/homebrew/bin/yarn
    npm: 8.5.5 - ~/Library/Caches/fnm_multishells/35700_1665020132817/bin/npm
  Browsers:
    Chrome: 105.0.5195.125
    Safari: 15.6.1
  npmPackages:
    @histoire/plugin-svelte: ^0.11.0 => 0.11.0 
    histoire: ^0.11.0 => 0.11.0

Used Package Manager

npm

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
• Check that this is a concrete bug. For Q&A open a GitHub Discussion.
• The provided reproduction is a minimal reproducible example of the bug.

[swyxio]

inline docs for svelte would be nice too! happy to brainstorm syntax with you... i dont think this style of docs will be very discoverable or easy to maintain

[Akryum]

Looks like sveltekit applies a transform to markdown files 🐈

[Akryum]

inline docs for svelte would be nice too! happy to brainstorm syntax with you... i dont think this style of docs will be very discoverable or easy to maintain

AFAIK Svelte doesn't support custom blocks like in Vue:

Maybe we could do something like this:

But then there is no syntax highlighting and we need to be careful about the indentation. And putting code examples with ``` will be cumbersome.

[Akryum]

Maybe a comment?

[swyxio]

@Akryum wow, if you can parse comments i think that'd work

but also maybe you just wanna support mdsvex as your preferred story rendering format instead of .md? (yes it has enough community traction that it isn't going to surprise any svelte users). syntax highlighting would be supported because "its just markdown"

thats what i loved about the old docz style of storybooking, for what its worth. multiple stories, all inline with arbitrary description for each story in markdown.

[Akryum]

Maybe a markdown file could be compiled on to a story component.

[swyxio]

might as well use mdsvex? :)