Skip to content

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

@eldarsadykov

Description

@eldarsadykov

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions