Snippets in JSX static site generators

[matkoch]

Is the feature request related to a problem

The default syntax of:

<!-- snippet: xyz -->

Won't work in JSX components. Instead it has to look something like this:

Describe the solution

• Markdown snippets would have to discover this new comment style {/* snippet: xyz */} in the place it should be included.
• Additionally, it would have to:
  • Put {` at the start and `} at the end of the snippet and consider these the new code fences (instead of ```)
  • Escape empty lines with \n

Describe alternatives considered

The alternative is not to use markdown snippets.

Additional context

No additional context.

[SimonCropp]

in what context are you using this?

markdown snippets is specifically meant to produce valid markdown, it seems this use-case is not producing valid (or at least non standard) markdown? ie if that file is markdown, shouldn't the renderer properly convert ``` to your screenshot above?

Will you want to use this from msbuild?

Will you want to re-process the same file? or is it a once only injection of snippets for rendering purposes?

[matkoch]

Found a workaround, so no longer relevent.

[matkoch]

Four years later, this is coming back at me :)

Some updated information:

• This is being used in an mdx file which is processed by fumadocs.
• Originally, I was using another SSG, so this seems to be a general issue.
• Since you mentioned "valid markdown" – AFAIU, the official Markdown spec doesn't support comments. However, <!-- .. --> works for most parsers. For MDX files it looks fair to say, that another comment format needs to be used.
• Same as with Allow to specify language mappings #740 I'd be good to have just a delegate (not using CLI tool / MSBuild task).
• Files are going to be re-processed, so any approach that involves converting back and forth would be rather inconvenient.

[matkoch]

This would work in both:

[//]: # (snippet: Sdk.props)
...
[//]: # (endSnippet)

A bit of AI conversation background: