Migration Guide

DocAnvil is pre-1.0, so breaking changes can happen between minor versions. This page will document migration steps as they come up.

Migrating Between Versions

Nothing to migrate yet! DocAnvil hasn't introduced any breaking changes that require manual intervention.

When breaking changes do land, you'll find step-by-step migration instructions here — covering config changes, renamed options, and anything else that might affect your project.

Coming From Another Tool

If you're moving an existing documentation site to DocAnvil, the process is straightforward:

1. Run docanvil new my-docs to scaffold a fresh project
2. Copy your Markdown files into the docs/ directory
3. Set up your navigation in nav.toml (or let auto-discovery handle it)
4. Adjust any tool-specific syntax (front matter format, component directives, etc.)

DocAnvil uses JSON front matter (not YAML), so you may need to convert front matter blocks. See Front Matter for the format.