Support for Markdoc

[louiss0]

Support for Markdoc

I'm here to ask for support for Markdoc. Why Because Markdoc is a great tool that makes working with components a breeze. It's a Markdoc renderer that allows its user to configure what is and is not allowed in Markdown. It's highly performant and has a good Language Server. If you want to learn about it you can go to their site But I will highlight some features down below.

Tags

A tag is a special syntax that allows its user to write HTML or Components in a different form. They work just like any component.

Self-closing tag.

{% abbr "PHP" title="Hypertext Preprocessor" /%}

Paired tag

{% details  %}

This is a set of details
{% /details %}

Global Functions

You can configure global functions to be called in your Markdown. A global function works like this.

{debug("name")}

Language Server

Markdoc's Language Server is good at catching bugs and knows about all the tags that you can use in Markdown. You can get auto complete for all the tags that you use.

Example, using Markdoc to write a proper <dl> tag with <dt> and <dd> as proper children.

[brc-dd]

It won't be supported. We rely on a specific flavor of markdown and don't intend to switch to something entirely different. Also, since you can already use vue in markdown, most of these differences are irrelevant. Regarding language server, you can use Volar and enable vitepress support in it. If you have any specific thing in your mind, that's supported in markdoc, but doesn't have any equivalent in vitepress, then please create a feature request for that.

[louiss0]

I don't think Volar can detect global components in Markdown. If I'm wrong Can you show me how to set it up?

[brc-dd]

Global components won't show auto-completions most-likely, unless you maintain a .d.ts file mapping those exports. Local components and any vue syntax should work fine with "vue.server.vitePress.supportMdFile": true

[louiss0]

I did this PR because I thought this was the only way to get support for autocomplete in Markdown!
Why was this not documented? Is the autocomplete of built-in components. going to be supported in the future? I don't know how to setup autocomplete for Vue projects.

[louiss0]

I'm trying to put all the types in the Global Components but I don't see the types for vitepress components.
What file am I supposed to put this setting in "vue.server.vitePress.supportMdFile": true.

[louiss0]

Where are the types for the components Vitepress ships with I can't find them.

[louiss0]

I forgot If you want to toy around with Markdoc please clone this repo.

To get a similar experience you can Install the language server and an Extension called Error Lens.
Just go to the first.md file and press Ctrl + Space

[louiss0]

Global components won't show auto-completions most-likely, unless you maintain a .d.ts file mapping those exports. Local components and any vue syntax should work fine with "vue.server.vitePress.supportMdFile": true