Use our public packages to convert your existing documentation to Mintlify. We currently support automated migration for:

Docusaurus

ReadMe

Don’t see your documentation provider or have a custom system? We can still help! Please contact support.

​
Commands

  • mintlify-scrape section [url] - Scrapes multiple pages in a site.
  • mintlify-scrape page [url] - Scrapes a single page in a site.
The commands automatically detect the framework.

​
Installation

You can install the package globally or for one-time use.

​
Global installation

npm install @mintlify/scraping@latest -g

​
One-time use

npx @mintlify/scraping@latest section [url]

​
OpenAPI migration

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]