Get started

Migrate from Mintlify

Convert a local Mintlify project into a new Velu docs directory with velu migrate mintlify. Beta.

Use velu migrate mintlify to move an existing Mintlify docs project into Velu. The command creates a new directory and leaves your Mintlify source untouched.

Mintlify migration is in beta. Behavior and coverage can change. Always run --dry-run first and review VELU-MIGRATION.md before you publish.

Prerequisites

  • Node.js 18 or newer
  • The Velu CLI (npm i -g @veluai/velu or npx @veluai/velu)
  • A local Mintlify project with docs.json or legacy mint.json

Migrate

Preview the migration

Run a dry run first. Velu analyzes the project and prints a report without writing files:

velu migrate mintlify ./mintlify-docs --out ./velu-docs --dry-run
Write the Velu project

When the plan looks right, run the migration for real:

velu migrate mintlify ./mintlify-docs --out ./velu-docs

Without --out, Velu creates a sibling directory named <source>-velu.

Validate and preview
cd velu-docs
velu validate .
velu dev .

docs.json takes precedence when both configs exist. Use --config mint.json to select the legacy file.

Options

OptionBehavior
--dry-runAnalyze and transform in memory; write nothing
--jsonPrint only the machine-readable report
--strictRefuse to write if any warning or error needs review
--out <directory>Set the destination (must not already exist)
--config docs.json|mint.jsonChoose the source config

Exit codes: 0 completed without compatibility errors, 1 invalid invocation or I/O failure, 2 compatibility errors (output is still written unless --strict), 3 strict mode blocked the write.

What gets migrated

AreaBehavior
ConfigMaps supported docs.json / mint.json fields into velu.json
NavigationKeeps groups, tabs, products, versions, languages, and OpenAPI refs
ContentConverts Markdown to MDX and maps common Mintlify components
AssetsCopies images, fonts, media, CSS, and JS into the new project
Custom CSS / JSPreserves project scripts; reports risks that need review
Mintlify sequoiaMaps to Velu's vepa preset
Mintlify mintMaps to Velu's thulir preset
Mintlify mapleMaps to Velu's aalam preset
Mintlify aspenMaps to Velu's nila preset

Every run writes VELU-MIGRATION.md and velu-migration-report.json in the output. Review those files before you publish.

After you migrate

  1. Install dependencies if package.json changed.
  2. Fix anything listed in the migration report.
  3. Preview with velu dev, then publish through the dashboard.

Migration never executes your project scripts, installs packages, or downloads remote assets. Features without a Velu equivalent (auth gates, analytics integrations, some navigation patterns) are reported for manual follow-up.

Next steps

Themes

Configure accents, fonts, and the Vepa layout preset.

Local development

Preview the migrated site with live reload.

Publishing

Push to GitHub and ship the new Velu site.

Was this page helpful?