Installation
CLI create-docus
Créez votre dossier de documentation
Utilisez le CLI create-docus pour créer un nouveau projet Docus :
npx create-docus my-docs
Vous pouvez choisir entre deux templates:
default: Configuration Docus de base pour une documentation monolinguei18n: Inclut le support d'internationalisation pour une documentation multilingue
# Créer avec le modèle i18n
npx create-docus my-docs -t i18n
Nous recommandons d'utiliser le gestionnaire de paquets npm.
Démarrez votre serveur de documentation en mode développement
Déplacez-vous dans votre dossier de documentation et démarrez votre serveur:
cd my-docs
npm run dev
Un aperçu de votre documentation sera disponible sur http://localhost:3000
Rédigez votre documentation
Rendez-vous dans la section Édition pour apprendre à rédiger votre documentation.
Skill pour assistant IA
Démarrez rapidement avec Docus en ajoutant des connaissances spécialisées à votre assistant IA (Cursor, Claude, etc.) :
npx skills add nuxt-content/docus
Ce skill vous aide à créer de la documentation plus rapidement en fournissant à votre assistant IA :
- 📝 Les meilleures pratiques pour rédiger de la documentation avec Docus
- 🎨 L'utilisation des composants MDC et des templates prêts à l'emploi
- 📚 Les guides de rédaction et les modèles de structure de contenu
- 🔧 Les conseils de configuration et de personnalisation
Une fois installé, votre assistant IA peut vous aider à créer rapidement de nouveaux projets de documentation, générer des pages avec la bonne structure, et rédiger du contenu en suivant les meilleures pratiques Docus.
Intégration du layer Docus
Docus v4 utilise une approche basée sur les layers Nuxt, vous pouvez étendre le layer Docus directement dans votre nuxt.config.ts avec extends: ['docus'] :
export default defineNuxtConfig({
extends: ['docus']
})