New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

@mintlify/scraping

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@mintlify/scraping

Scrape documentation frameworks to Mintlify docs

4.0.161
Version published
Weekly downloads
34K
-0.46%
Maintainers
3
Weekly downloads
 
Created

@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.

FAQs

Package last updated on 22 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts