UNPKG

@mintlify/scraping

Version:

Scrape documentation frameworks to Mintlify docs

64 lines (40 loc) • 1.22 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# @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: [![](https://dcbadge.vercel.app/api/server/ACREKdwjG5)](https://discord.gg/ACREKdwjG5) _Built with 💚 by the Mintlify community._