É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 est la première page que vos visiteurs voient à la racine / de votre site. Par défaut, Docus utilise le fichier content/index.md pour afficher cette page.

Page d'accueil Markdown (par défaut)

Par défaut, la page d'accueil correspond au fichier content/index.md. La syntaxe MDC vous offre la possibilité d'utiliser des composants Vue, y compris les slots et les props dans vos fichiers .md.

Lorsqu'aucune page d'accueil personnalisée n'existe, Docus automatiquement:

• Crée une collection de contenu landing pour content/index.md
• Enregistre la route / pour afficher votre page d'accueil Markdown

Page d'accueil Vue personnalisée

Vous pouvez personnaliser votre page d'accueil en créant une page Vue à app/pages/index.vue. Cela vous donne un contrôle total avec les composants Vue, des layouts personnalisés et des interactions js avancées.

Lorsque vous créez app/pages/index.vue, Docus :

• Ne créera pas la collection landing
• N'enregistrera pas la route d'accueil
• Utilisera votre page Vue personnalisée comme page d'accueil

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

Sans dossier docs

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.

content/
├── index.md              # Page d'accueil → /
├── getting-started.md    # Documentation → /getting-started
└── guide/
    └── introduction.md   # Documentation → /guide/introduction

Avec dossier docs

Vous pouvez optionnellement organiser vos fichiers de documentation dans un sous-dossier docs/. Lorsque Docus détecte un dossier docs/ dans votre répertoire content/, il préfixe automatiquement toutes les URLs de documentation avec /docs.

content/
├── index.md                  # Page d'accueil → /
└── docs/
    ├── getting-started.md    # Documentation → /docs/getting-started
    └── guide/
        └── introduction.md   # Documentation → /docs/guide/introduction

Exemple avec contenu mixte :

Puisque Docus est un layer Nuxt, vous pouvez combiner la documentation Markdown avec des pages Vue personnalisées :

├── app/
│   └── pages/
│       ├── blog.vue          # Page blog personnalisée → /blog
│       └── contact.vue       # Page contact personnalisée → /contact
└── content/
    ├── index.md              # Page d'accueil → /
    └── docs/                 # Documentation → /docs/*
        ├── getting-started.md
        └── api/
            └── reference.md

Cette structure vous donne la flexibilité de construire un site web complet avec Docus. Utilisez Markdown pour la documentation et des pages Vue pour les fonctionnalités personnalisées comme les blogs, tableaux de bord, ou toute page interactive.

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.

CodeAperçu

content/getting-started/edition.md

---
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 :