Markdown

Comment écrire des documents avec la syntaxe MDC.

Syntaxe MDC

Lisez le guide détaillé d'utilisation de MDC dans la documentation Nuxt Content.

Composants

Consultez les composants MDC fournis par shadcn-docs-nuxt.

Intégration avec VS Code

L'extension MDC

Nuxt MDC est une extension VS Code qui fournit une coloration syntaxique et une autocomplétion pour la syntaxe MDC.

Lancez l'ouverture rapide de VS Code Ctrl + P, collez la commande suivante et appuyez sur Entrée.

ext install Nuxt.mdc

Activer l'autocomplétion des métadonnées des composants

Paramètres de VSCode

.vscode/settings.json
{
  "mdc.enableComponentMetadataCompletions": true}

Installer le module nuxt-component-meta

Ajoutez la dépendance nuxt-component-meta à votre projet :

npm
pnpm
bun
yarn
npm i nuxt-component-meta

Ajoutez nuxt-component-meta à la section modules de votre nuxt.config.ts et configurez éventuellement le module :

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

Une fois que votre projet a été construit ou est en cours d'exécution sur le serveur de développement, l'extension analysera automatiquement votre projet pour les métadonnées des composants et fournira des suggestions basées sur les composants découverts sans configuration supplémentaire.

Conseils

Masquer le titre dans la table des matières

0.4.7

Définir l'id du titre sur hide-toc masquera le titre dans la table des matières.

:h2[Notes de bas de page]{id="hide-toc"}
Modifier cette page
Installation
Comment installer shadcn-docs-nuxt dans votre application.
Pages
Attributs du front matter utilisés dans shadcn-docs-nuxt.