Migration
Migrating from Docus v3 to v4
Docus v4 introduces a new layer-based approach that leverages the official Nuxt CLI instead of the custom Docus CLI. While your existing content and configuration remain compatible, you'll need to update your commands and project setup.
⚠️ Breaking Changes
The main breaking changes are related to CLI commands:
| v3 | v4 |
|---|---|
npx docus init my-docs | npx create-docus my-docs |
docus dev | nuxt dev --extend docus |
docus build | nuxt build --extend docus |
Migrating to Docus
Already using a Markdown-based solution for your documentation? Whether it’s Docus v1, the Nuxt UI Pro docs template, or another static site setup, migrating to Docus is simple and straightforward.
Docus offers a clean and maintainable solution with a single dependency: the Docus library itself. There’s no need to manage multiple .dependencies With everything built-in and maintained together, keeping your documentation up to date is easier than ever.
To migrate, just move your existing Markdown files into the content/ directory of the Docus starter.
From there, you have two scenarios:
- If your current docs already use Nuxt Content and the MDC syntax, make sure the components used in your content exist in Nuxt UI. If any components are missing, you can easily create your own custom ones.
- If you’re using standard Markdown, you can copy your files as is. Then, enhance your documentation progressively using the built-in components provided by Nuxt UI.
Once your content has been moved to the content/ folder, you can go through the configuration section to easily customize your app.
Docus is designed to focus on writing content, so if you're already using Markdown, you can easily switch to it.