SKORI 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.
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']
})
Édition en ligne avec Nuxt Studio
Créez un nouveau projet sur Nuxt Studio
Depuis votre tableau de bord utilisateur ou équipe, cliquez sur le bouton New project puis choisissez Start from a template et sélectionnez Docus. Clonez-le sur votre compte GitHub personnel ou dans une organisation de votre choix.
Déployez en un clic
Une fois votre projet créé et dans le tableau de bord du projet, rendez-vous dans la section Deploy, choisissez l'onglet GitHub Pages puis cliquez sur le bouton Deploy.
Selfhosted.Rédigez votre documentation dans l'éditeur
Une fois le déploiement terminé, vous pourrez afficher l'aperçu de votre documentation. Vous pouvez parcourir vos pages de contenu pour les éditer ou en créer de nouvelles.