Usage

bash
holydocs migrate <platform> [options]

Imports content from another docs platform. Support is partial today: some platforms copy files automatically, while others print the manual export steps you should follow.

Options

OptionDescriptionDefault
--source <path>Source directory for file-based migrationsCurrent directory
--api-key <key>API key for ReadMe migrations
--url <url>Remote URL for platforms that need one
--token <token>Token for platforms that need one
--dir <path>Output directoryCurrent directory

Supported Platforms

PlatformCurrent Behavior
mintlifyCopies pages and assets so you can finish setup in HolyDocs
docusaurusCopies docs content and strips some Docusaurus-specific frontmatter
gitbookPrints the current manual migration steps
readmeChecks the ReadMe API and lists categories
confluencePrints the current manual migration steps
notionPrints the current manual migration steps

Mintlify

bash
holydocs migrate mintlify

Mintlify migration copies the content tree first so you can finish the setup inside your HolyDocs project.

You can also migrate from another source directory:

bash
holydocs migrate mintlify --source ../old-docs --dir ./docs

Docusaurus

bash
holydocs migrate docusaurus --source ./legacy-site --dir ./docs

The current Docusaurus migration:

  • Copies .md and .mdx files
  • Removes some Docusaurus-specific frontmatter like sidebar_position
  • Converts sidebar_label into title when needed

You still need to create or finish docs.json yourself afterward.

GitBook

bash
holydocs migrate gitbook

Today this prints the manual export steps. It does not yet convert a GitBook export automatically.

ReadMe

bash
holydocs migrate readme --api-key rdme_xxxxxxxxxxxxxxxx

Today this verifies the ReadMe API key and lists the categories it finds. Full page import is still a follow-up manual step.

Common Flow After Migration

For most migrations, the next steps are:

  1. Run holydocs init if you still need a local HolyDocs config scaffold
  2. Run holydocs check
  3. Run holydocs dev
  4. Run holydocs deploy

holydocs migrate uses a positional platform argument. It does not support the older --from, --config, or --dry-run flags.

Ask a question... ⌘I