# @mintlify/scraping

> Scrape documentation frameworks to Mintlify docs

Latest version **4.0.1041** (published 2026-09-25) · Elastic-2.0 license · 294.8K weekly downloads

## Install

```sh
npm install @mintlify/scraping
pnpm add @mintlify/scraping
yarn add @mintlify/scraping
bun add @mintlify/scraping
```

Provides the command `mintlify-scrape`.

## Health

**Score 85/100 (A)** — status: active.

Positive: moderate downloads; has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

## Facts

| | |
|---|---|
| Version | 4.0.1041 |
| Published | 2026-09-25 |
| First published | 2023-06-02 |
| Weekly downloads | 294.8K |
| License | Elastic-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 17 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mintlify, Inc. |
| Maintainers | dks333, hanmint, hahnbee, shouchem-mintlify, kylefinken, lucaspunz |
| Keywords | mintlify, mint, scraping |

## Links

- npm: https://www.npmjs.com/package/@mintlify/scraping
- Repository: https://github.com/mintlify/mint
- Homepage: https://github.com/mintlify/mint#readme
- Issues: https://github.com/mintlify/docs/issues
- npm.io page: https://npm.io/package/@mintlify/scraping

## Dependencies (17)

- [zod](https://npm.io/package/zod.md) 3.24.0
- [yargs](https://npm.io/package/yargs.md) 17.7.1
- [graphql](https://npm.io/package/graphql.md) 16.11.0
- [js-yaml](https://npm.io/package/js-yaml.md) 4.3.1
- [unified](https://npm.io/package/unified.md) 11.0.5
- [fs-extra](https://npm.io/package/fs-extra.md) 11.1.1
- [remark-gfm](https://npm.io/package/remark-gfm.md) 4.0.0
- [remark-mdx](https://npm.io/package/remark-mdx.md) 3.0.1
- [neotraverse](https://npm.io/package/neotraverse.md) 0.6.18
- [rehype-parse](https://npm.io/package/rehype-parse.md) 9.0.1
- [remark-parse](https://npm.io/package/remark-parse.md) 11.0.0
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) 5.7.3
- [@mintlify/common](https://npm.io/package/@mintlify/common.md) 1.0.1171
- [remark-stringify](https://npm.io/package/remark-stringify.md) 11.0.0
- [unist-util-visit](https://npm.io/package/unist-util-visit.md) 5.0.0
- [hast-util-to-mdast](https://npm.io/package/hast-util-to-mdast.md) 10.1.0
- [mdast-util-mdx-jsx](https://npm.io/package/mdast-util-mdx-jsx.md) 3.1.3

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads
- [@vendure/ngx-translate-extract](https://npm.io/package/@vendure/ngx-translate-extract.md) — 48.4K weekly downloads

## Recent versions

- 4.0.1041 (latest) — 2026-09-25
- 4.0.1040 — 2026-09-25
- 4.0.1039 — 2026-09-24
- 4.0.1038 — 2026-09-24
- 4.0.1037 — 2026-09-24
- 4.0.1036 — 2026-09-24
- 4.0.1035 — 2026-09-24
- 4.0.1034 — 2026-09-23
- 4.0.1033 — 2026-09-23
- 4.0.1032 — 2026-09-22
- 4.0.1031 — 2026-09-22
- 4.0.1030 — 2026-09-22
- 4.0.1029 — 2026-09-22
- 4.0.1028 — 2026-09-22
- 4.0.1027 — 2026-09-21
- … 1202 more at https://npm.io/package/@mintlify/scraping/versions

## README

# @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]
```

GitBook, ReadMe, and Docusaurus sites are rendered with [Puppeteer](https://pptr.dev), which is an optional peer dependency. Include it when scraping those sites:

```
npx -p @mintlify/scraping@latest -p puppeteer mintlify-scrape section [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:

[![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5)

_Built with 💚 by the Mintlify community._

---
_Source: https://npm.io/package/@mintlify/scraping · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._