Markdown

如何使用 MDC 语法编写文档。

VS Code 集成

Nuxt MDC 是一个 VS Code 扩展，为 MDC 语法提供语法高亮和自动补全功能。

启动 VS Code 快速打开 Ctrl + P，粘贴以下命令并按回车。

ext install Nuxt.mdc

需要 Nuxt.mdc >= 0.3.1

.vscode/settings.json

{
  "mdc.enableComponentMetadataCompletions": true}

将 nuxt-component-meta 依赖添加到您的项目中：

npm

pnpm

bun

yarn

npm i nuxt-component-meta

将 nuxt-component-meta 添加到您的 nuxt.config.ts 的 modules 部分，并可选择配置该模块：

nuxt.config.ts

export default defineNuxtConfig({
  modules: ['nuxt-component-meta'],
});

一旦您的项目构建完成或在开发服务器上运行，扩展将自动扫描您的项目以获取组件元数据，并基于发现的组件提供建议，无需额外配置。

0.4.7

将标题 id 设置为 hide-toc 将从目录中隐藏该标题。

:h2[Footnotes]{id="hide-toc"}

On This Page