Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify-sam-fix-thumbnails.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

Docusaurus

ReadMe

Don’t see your docs provider or have a home grown 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 will automatically detect the framework.

​
Installation

First, install the package: 
npm i @mintlify/scraping
One-time use: 
npx @mintlify/scraping@latest section [url]
Global installation: 
npm install @mintlify/scraping@latest -g
Global usage: 
mintlify-scrape section [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]