Bien démarrer
Installation
Commencez avec Docus.
CLI create-docus
Créez votre dossier de documentation
Utilisez le CLI create-docus pour créer un nouveau projet Docus :
Terminal
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
Terminal
# 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:
Terminal
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 Syntaxe Markdown pour apprendre à rédiger votre documentation.
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'] :
nuxt.config.ts
export default defineNuxtConfig({
extends: ['docus']
})