Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@mintlify/scraping

Package Overview
Dependencies
Maintainers
0
Versions
229
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

  • 3.0.184
  • npm
  • Socket score

Version published
Weekly downloads
16K
decreased by-17.28%
Maintainers
0
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

Overwriting

Add the --overwrite flag if they want to overwrite their current files.

Frameworks

We currently support:

  • Docusaurus
  • GitBook
  • ReadMe
  • Intercom

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

FAQs

Package last updated on 21 Oct 2024

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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc