Sign In

@mintlify/scraping

Package Overview
Dependencies
Maintainers
5
Versions
1156
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mintlify/scraping

Scrape documentation frameworks to Mintlify docs

Source
npmnpm
Version
4.0.968
Version published
Weekly downloads
459K
35.76%
Maintainers
5
Weekly downloads
 
Created
Source

@mintlify/scraping

Scrape documentation frameworks to Mintlify docs.

Commands

  • mintlify-scrape section [url] - scrapes multiple pages in a site
  • mintlify-scrape page [url] - scrapes a single page in a site

Frameworks

We currently support:

  • ReadMe
  • Docusarus
  • Gitbook (coming soon!)

The commands will automatically detect the framework.

🚀 Installation

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]

Community

Join our Discord community if you have questions or just want to chat:

Built with 💚 by the Mintlify community.

Keywords

mintlify

FAQs

Package last updated on 20 Aug 2026

Related posts