content icon indicating copy to clipboard operation
content copied to clipboard

Feature Request: Document & Highlight Inline Vue Component Usage in Markdown

Open eldarsadykov opened this issue 1 month ago • 0 comments

Is your feature request related to a problem? Please describe

While using Nuxt Content, I looked for documentation about using MDC Vue components inline within markdown text. The docs only describe the block syntax, such as:

::component-name
Default slot content
::

However, there is an inline variant that works (seemingly undocumented), e.g.:

This is a paragraph with an :component-name[inline Vue component] within it.

This syntax works, but:

  • It does not appear anywhere in the documentation.
  • MDC syntax highlighting does not recognize it, suggesting it’s an accidental or unsupported feature.

Describe the solution you’d like

  • Officially document the inline syntax as a valid and supported feature.
  • Provide proper MDC highlighting and editor support for inline component syntax.

Describe alternatives you've considered

  • Implementing a custom Remark plugin to manually parse inline patterns.
  • However, this seems unnecessary if inline syntax is actually supported.

eldarsadykov avatar Dec 06 '25 12:12 eldarsadykov