Skip to content

Commit 86403df

Browse files
committed
docs: added firefox extension
1 parent 5d37063 commit 86403df

File tree

6 files changed

+175
-2
lines changed

6 files changed

+175
-2
lines changed

integrations/llamaindex.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This tool integrates ScrapeGraph with LlamaIndex, providing intelligent web scra
1010
<Card
1111
title="Official LlamaHub Documentation"
1212
icon="book"
13-
href="https://llamahub.ai/l/tools/llama-index-tools-scrapegraph"
13+
href="https://docs.llamaindex.ai/en/stable/api_reference/tools/scrapegraph/"
1414
>
1515
View the integration on LlamaHub
1616
</Card>

mint.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,13 @@
8484
"pages": [
8585
"services/smartscraper",
8686
"services/localscraper",
87-
"services/markdownify"
87+
"services/markdownify",
88+
{
89+
"group": "Extensions",
90+
"pages": [
91+
"services/extensions/firefox"
92+
]
93+
}
8894
]
8995
},
9096
{

services/extensions/firefox.mdx

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
title: 'Firefox'
3+
description: 'Extract data from any webpage directly in your browser'
4+
icon: 'firefox'
5+
---
6+
7+
<Frame>
8+
<img src="/services/images/firefox-banner.png" alt="ScrapeGraphAI Firefox Extension" />
9+
</Frame>
10+
11+
## Overview
12+
13+
The ScrapeGraphAI Firefox Extension brings the power of our AI-driven data extraction directly to your browser. With a simple prompt, you can extract structured data from any webpage you're visiting, making web research and data collection effortless.
14+
15+
<Note>
16+
Install the extension from the [Firefox Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/scrapegraphai-extension/)
17+
</Note>
18+
19+
## Key Features
20+
21+
<CardGroup cols={2}>
22+
<Card title="One-Click Access" icon="mouse-pointer">
23+
Extract data from any webpage with a single click
24+
</Card>
25+
<Card title="Natural Language Prompts" icon="comments">
26+
Describe what you want to extract in plain English
27+
</Card>
28+
<Card title="Structured Output" icon="table">
29+
Get clean, structured JSON data
30+
</Card>
31+
<Card title="Browser Integration" icon="browser">
32+
Seamless integration with your browsing experience
33+
</Card>
34+
</CardGroup>
35+
36+
## Getting Started
37+
38+
### API Key Setup
39+
40+
First, you'll need to get your ScrapeGraphAI API key:
41+
42+
<Frame>
43+
<img src="/services/images/firefox-api-key.png" alt="Firefox Extension API Key Setup" />
44+
</Frame>
45+
46+
1. Get your API key from the [dashboard](https://dashboard.scrapegraphai.com)
47+
2. Click the ScrapeGraphAI icon in your toolbar
48+
3. Enter your API key in the settings
49+
4. Click Save to store your API key securely
50+
51+
### Usage
52+
53+
Once your API key is set up, you can start extracting data:
54+
55+
<Frame>
56+
<img src="/services/images/firefox-main-view.png" alt="Firefox Extension Main View" />
57+
</Frame>
58+
59+
1. Navigate to any webpage you want to extract data from
60+
2. Click the ScrapeGraphAI icon in your toolbar
61+
3. Enter your prompt describing what information you want to extract
62+
4. Click Extract to receive structured JSON data based on your prompt
63+
64+
### Example: Reddit Posts Extraction
65+
66+
Here's an example of extracting posts from Reddit:
67+
68+
```text
69+
"List me all the posts in the page, extracting title, post url, image url, upvotes and comments"
70+
```
71+
72+
The extension will return structured JSON data like this:
73+
74+
```json
75+
{
76+
"posts": [
77+
{
78+
"title": "Example Reddit Post Title",
79+
"post_url": "https://reddit.com/r/example/post1",
80+
"image_url": "https://i.redd.it/example1.jpg",
81+
"upvotes": 1234,
82+
"comments": 56
83+
},
84+
{
85+
"title": "Another Reddit Post",
86+
"post_url": "https://reddit.com/r/example/post2",
87+
"image_url": "https://i.redd.it/example2.jpg",
88+
"upvotes": 789,
89+
"comments": 23
90+
}
91+
// ... more posts
92+
]
93+
}
94+
```
95+
96+
## Example Use Cases
97+
98+
### Research
99+
- Extract company information
100+
- Gather product details
101+
- Collect article data
102+
- Compile contact information
103+
104+
### Data Collection
105+
- Market research
106+
- Competitive analysis
107+
- Content aggregation
108+
- Price monitoring
109+
110+
### Personal Use
111+
- Save article summaries
112+
- Extract recipe ingredients
113+
- Compile reading lists
114+
- Save product comparisons
115+
116+
## Example Prompts
117+
118+
Here are some example prompts you can use with the extension:
119+
120+
```text
121+
"Extract the main article content, author, and publication date"
122+
"Get all product information including price, features, and specifications"
123+
"Find all contact information including email, phone, and social media links"
124+
"Extract company information including location, size, and industry"
125+
```
126+
127+
## Best Practices
128+
129+
### Writing Effective Prompts
130+
1. Be specific about what you want to extract
131+
2. Include all relevant fields in your prompt
132+
3. Use clear, natural language
133+
4. Consider the structure of your desired output
134+
135+
### Tips for Better Results
136+
- Wait for the page to load completely before extraction
137+
- Ensure you have access to all content you want to extract
138+
- Use specific terminology when requesting technical information
139+
- Review the extracted data for accuracy
140+
141+
## Privacy & Security
142+
143+
- The extension only accesses webpage content when explicitly triggered
144+
- Data is processed securely through ScrapeGraphAI's servers
145+
- No personal browsing data is stored or tracked
146+
- Complies with Mozilla's privacy requirements
147+
148+
## Support & Resources
149+
150+
<CardGroup cols={2}>
151+
<Card title="Documentation" icon="book" href="/introduction">
152+
Comprehensive guides and tutorials
153+
</Card>
154+
<Card title="Community" icon="discord" href="https://discord.gg/uJN7TYcpNa">
155+
Join our Discord community
156+
</Card>
157+
<Card title="GitHub" icon="github" href="https://github.com/ScrapeGraphAI">
158+
Check out our open-source projects
159+
</Card>
160+
<Card title="Support" icon="headset" href="mailto:[email protected]">
161+
Get help with the extension
162+
</Card>
163+
</CardGroup>
164+
165+
<Card title="Ready to Start?" icon="rocket" href="https://addons.mozilla.org/en-US/firefox/addon/scrapegraphai-extension/">
166+
Install the Firefox extension now and start extracting data with ease!
167+
</Card>

services/images/firefox-api-key.png

22.7 KB
Loading

services/images/firefox-banner.png

662 KB
Loading

services/images/firefox-main-view.png

21.1 KB
Loading

0 commit comments

Comments
 (0)