Migration
Migration de Docus v3 vers v4
Docus v4 introduit une nouvelle version qui exploite le CLI Nuxt au lieu du CLI Docus. Votre contenu et vos configurations existants restent compatibles, il suffit simplement de mettre à jour la commande pour lancer le serveur ou le build.
⚠️ Breaking changes
Les principaux changements cassants sont liés aux commandes CLI :
| v3 | v4 |
|---|---|
npx docus init my-docs | npx create-docus my-docs |
docus dev | nuxt dev --extends docus |
docus build | nuxt build --extends docus |
Migrer vers Docus
Vous utilisez déjà une solution basée sur Markdown pour votre documentation ? Que ce soit Docus v1, le template de docs Nuxt UI, ou une autre solution de site statique, migrer vers Docus est simple et direct.
Docus offre une solution propre et maintenable avec une seule dépendance : la bibliothèque Docus elle-même. Plus besoin de gérer de multiples dépendances. Tout est intégré et maintenu ensemble, ce qui facilite la mise à jour de votre documentation.
Pour migrer, déplacez simplement vos fichiers Markdown existants dans le dossier content/ du starter Docus.
À partir de là, deux scénarios :
- Si votre documentation actuelle utilise déjà Nuxt Content et la syntaxe MDC, assurez-vous que les composants utilisés existent dans Nuxt UI. Si certains composants manquent, vous pouvez facilement créer les vôtres.
- Si vous utilisez du Markdown standard, vous pouvez copier vos fichiers tels quels. Ensuite, améliorez progressivement votre documentation en utilisant les composants intégrés fournis par Nuxt UI.
Une fois votre contenu déplacé dans le dossier content/, vous pouvez consulter la section configuration pour personnaliser facilement votre application.
Docus est conçu pour se concentrer sur la rédaction de contenu, donc si vous utilisez déjà Markdown, vous pouvez facilement passer à Docus.