zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: simplified migration instructions

Browse Source
This commit is contained in:
saberzero1
2026-04-03 14:00:00 +02:00
parent 00c4e392ff
commit 712b4477b7
4 changed files with 124 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/cli/index.md
View File

@@ -24,7 +24,6 @@ You can run the CLI using `npx quartz`.
- [[cli/sync|sync]]: Push and pull changes between your local machine and GitHub.
- [[cli/upgrade|upgrade]]: Upgrade the Quartz framework to the latest version. Also available as `npx quartz update`.
- [[cli/restore|restore]]: Recover your content folder from the local cache.
- [[cli/migrate|migrate]]: Convert older configuration files to the new YAML format.
- [[cli/plugin|plugin]]: Install, add, remove, prune, and configure plugins. Use `plugin install` with flags for lockfile/config sync, updates, and checks.
- [[cli/tui|tui]]: Use a terminal interface to manage plugins and layout.

32
docs/cli/migrate.md
View File

@@ -1,32 +0,0 @@
---
title: quartz migrate
---
The `migrate` command helps you transition your project from Quartz 4 to Quartz v5 by converting your configuration files.
## When to Use
Use this command if you have an existing Quartz 4 project and want to upgrade to the new YAML-based configuration system introduced in v5.
## What it Does
When you run `npx quartz migrate`, the CLI performs several automated steps:
1. **Read Configuration**: It parses your existing `quartz.config.ts` and `quartz.layout.ts` files.
2. **Map Plugins**: It identifies the plugins you are using and maps them to their v5 equivalents.
3. **Generate YAML**: It creates a new `quartz.config.yaml` file that contains all your settings, theme colors, and plugin configurations.
4. **Backup**: It keeps your old `.ts` files so you can refer back to them if needed.
```shell
npx quartz migrate
```
## Verification
After running the migration, you should check the following:
- **Theme Colors**: Ensure your custom colors were correctly transferred to the `theme` section of `quartz.config.yaml`.
- **Plugin Options**: Verify that any custom options you passed to plugins (like `linkClickBehavior`) are present in the new config.
- **Layout**: Check that your component order in the `layout` section matches your previous setup.
For a comprehensive guide on the entire migration process, including manual steps, see [[getting-started/migrating]].