Édition
Docus vous permet d'écrire tout votre contenu en Markdown mais offre aussi la possibilité d'intégrer des composants grâce à la syntaxe MDC fournie par Nuxt Content.
Page d'accueil
La page d'accueil correspond au fichier index.md. La syntaxe MDC enrichit Markdown avec la possibilité d'utiliser des composants Vue, y compris les slots et les props dans vos fichiers .md.
Composants
MDC fournit une syntaxe dédiée pour utiliser facilement des composants Vue dans votre contenu :
:::u-page-feature
:::
Slots
Les slots peuvent recevoir du texte ou d'autres composants.
- Slot par défaut est rendu directement dans le composant ou avec
#default. - Slots nommés sont définis en utilisant le symbole
#suivi du nom du slot.
:::u-page-feature
#title
Nuxt 4
#description
Propulsé par Nuxt 4 pour des performances et un SEO optimaux.
:::
Props
Les props sont passées en syntaxe inline ou via le frontmatter YAML dans le bloc du composant :
:::u-page-feature{icon="i-simple-icons-nuxt" to="https://nuxt.com"}
#title
Nuxt 4
#description
Propulsé par Nuxt 4 pour des performances et un SEO optimaux.
:::
:::u-page-feature
---
icon: i-simple-icons-nuxt
to: https://nuxt.com
---
#title
Nuxt 4
#description
Propulsé par Nuxt 4 pour des performances et un SEO optimaux.
:::
Pages de documentation
content/ correspond directement à une route de page.Pour commencer, éditez ou ajoutez simplement des fichiers .md dans le dossier content/ pour mettre à jour vos pages. Docus gère automatiquement le routage, la navigation et la recherche plein texte.
Frontmatter
Chaque fichier du dossier content/ commence par la syntaxe --- en haut de la page. Cela correspond au frontmatter de votre fichier, une convention des CMS basés sur Markdown pour fournir des métadonnées aux pages.
---
title: 'Édition'
description: 'Apprenez à rédiger votre documentation.'
---
<!-- Contenu de la page en pur Markdown -->
Paramètres
Les pages du répertoire /content sont définies comme type page dans Nuxt Content. Elles suivent toutes la même structure avec les clés de frontmatter existantes :
| Clé | Type | Description | |
title | string | Titre de la page. Affiché en haut de la page. Utilisé comme titre SEO si la clé seo n'est pas fournie. | |
description | string | Description de la page. Affichée sous le titre en haut de la page. Utilisée comme description SEO si la clé seo n'est pas fournie. | |
navigation | boolean | Définit si la page est incluse dans la navigation latérale gauche. | |
seo | { title: string, description: string } | Métadonnées SEO de votre page. |