Migration

You can use our public packages to scrape documentation frameworks to Mintlify. We currently support migration for:

Docusaurus

GitBook

ReadMe

Don’t see your docs provider or have a home grown system? We can still help! Please get in touch at sales@mintlify.com.

Commands

mintlify-scrape section [url] - Scrapes multiple pages in a site.
mintlify-scrape page [url] - Scrapes a single page in a site.

The commands will automatically detect the framework.

🚀 Installation

First, install the package:

npm i @mintlify/scraping

One-time use:

npx @mintlify/scraping@latest section [url]

npx @mintlify/scraping@latest page [url]

Global installation:

npm install @mintlify/scraping@latest -g

Global usage:

mintlify-scrape section [url]

mintlify-scrape page [url]

Provide the relative path or URL to the OpenAPI file to generate frontmatter files for each endpoint.

mintlify-scrape openapi-file [openApiFilename]

-w, --writeFiles  Whether or not to write the frontmatter files [boolean] [default: true]
-o, --outDir      The folder in which to write any created frontmatter files [string]

Getting Started

Writing Content

API References

Configurations

Advanced

Docusaurus

GitBook

ReadMe

Commands

🚀 Installation

Docusaurus

GitBook

ReadMe

​Commands

​🚀 Installation

Commands

🚀 Installation