Skip to content

Commit 0c33747

Browse files
committed
chore: reformat markdown with prettier
1 parent 9c3b33e commit 0c33747

File tree

233 files changed

+4332
-4542
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

233 files changed

+4332
-4542
lines changed

sources/academy/build-and-publish/actor-ideas/what_software_an_actor_can_be.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@ Any repetitive job matching the following criteria might be suitable for turning
150150

151151
If you look closely, you'll start seeing opportunities for new Actors everywhere. Be creative!
152152

153-
154153
## Use the Actor ideas page
155154

156155
The [Actor ideas](https://apify.com/ideas) page is where you can find inspiration for new Actors sourced from the Apify community.
@@ -166,28 +165,22 @@ Build and publish new tools on Apify and have multiple chances to win big prizes
166165
:::
167166

168167
1. _Visit_ [apify.com/ideas](https://apify.com/ideas) to find ideas that interest you. Look for ideas that align with your skills.
169-
170-
1. _Select an Actor idea_: Review the details and requirements. Check the status—if it's marked **Open to develop**, you can start building.
171-
172-
1. _Build your Actor_: Develop your Actor based on the idea. You don't need to notify Apify during development.
173-
174-
1. _Prepare for launch_: Ensure your Actor meets quality standards and has a comprehensive README with installation instructions, usage details, and examples.
175-
176-
1. _Publish your Actor_: Deploy your Actor on Apify Store and make it live.
177-
178-
<!-- 1. _Claim the idea_: After publishing, email [ideas@apify.com](mailto:ideas@apify.com) with your Actor URL and the original idea. Apify will tag the idea as **Completed** and link it to your Actor.
179-
180-
1. To claim an idea, ensure your Actor is functional, README contains relevant information, and your Actor closely aligns with the original idea. -->
181-
182-
1. _Monitor and optimize_: Track your Actor's performance and user feedback. Make improvements to keep your Actor current.
168+
2. _Select an Actor idea_: Review the details and requirements. Check the status—if it's marked **Open to develop**, you can start building.
169+
3. _Build your Actor_: Develop your Actor based on the idea. You don't need to notify Apify during development.
170+
4. _Prepare for launch_: Ensure your Actor meets quality standards and has a comprehensive README with installation instructions, usage details, and examples.
171+
5. _Publish your Actor_: Deploy your Actor on Apify Store and make it live.
172+
<!--
173+
1. _Claim the idea_: After publishing, email [ideas@apify.com](mailto:ideas@apify.com) with your Actor URL and the original idea. Apify will tag the idea as **Completed** and link it to your Actor.
174+
1. To claim an idea, ensure your Actor is functional, README contains relevant information, and your Actor closely aligns with the original idea.
175+
-->
176+
6. _Monitor and optimize_: Track your Actor's performance and user feedback. Make improvements to keep your Actor current.
183177

184178
<!-- #### Multiple developers for one idea
185179
186180
Apify Store can host multiple Actors with similar functions. However, the "first come, first served" rule applies—the first developer to claim an idea receives the **Completed** tag and a link from the Actor ideas page.
187181
188182
Competition motivates developers to improve the code. You can still build the Actor, but differentiate with a unique set of features. -->
189183

190-
191184
<!-- ### Submit your own ideas
192185
193186
The Ideas page is also where you contribute concepts to drive innovation in the community.

sources/academy/build-and-publish/apify-store-basics/actor_description_seo_description.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ You can change descriptions and names as many times as you want.
2222

2323
## Regular description vs. SEO description
2424

25-
| | Actor description & name | SEO description & name |
26-
|---|---|---|
27-
| Name length | 40-50 characters | 40-50 characters |
28-
| Description length | 300 characters | 145-155 characters |
29-
| Visibility | Visible on Store | Visible on Google |
25+
| | Actor description & name | SEO description & name |
26+
| ------------------ | ------------------------ | ---------------------- |
27+
| Name length | 40-50 characters | 40-50 characters |
28+
| Description length | 300 characters | 145-155 characters |
29+
| Visibility | Visible on Store | Visible on Google |
3030

3131
### Description & Actor name
3232

@@ -58,7 +58,7 @@ Learn more about search intent here: [SEO](/academy/actor-marketing-playbook/pro
5858

5959
## Where can Actor descriptions be set?
6060

61-
Both descriptions can be found and edited on the very right **Publication tab → Display information.** It has to be done separately for each Actor.
61+
Both descriptions can be found and edited on the very right **Publication tab → Display information.** It has to be done separately for each Actor.
6262

6363
:::note
6464

@@ -81,33 +81,31 @@ When writing a description, less is more. You only have a few seconds to capture
8181
### Use variations and experiment 🔄
8282

8383
- _SEO name vs. regular name_:
84-
- name: Airbnb Scraper
85-
- SEO name: Airbnb Data Scraper
84+
- name: Airbnb Scraper
85+
- SEO name: Airbnb Data Scraper
8686
- _Keywords on the web page_:<br/>
87-
Include variations, e.g. Airbnb API, Airbnb data, Airbnb data scraper, Airbnb rentals, Airbnb listings
88-
- No-code scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
89-
- Scrape Airbnb listings without official Airbnb API!
87+
Include variations, e.g. Airbnb API, Airbnb data, Airbnb data scraper, Airbnb rentals, Airbnb listings
88+
- No-code scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
89+
- Scrape Airbnb listings without official Airbnb API!
9090
- _Scraping/automation process variations_:<br/>
91-
Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction tool, extract data, get data
92-
- Scrape XYZ data, scraped data, data scraper, data crawler.
91+
Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction tool, extract data, get data
92+
- Scrape XYZ data, scraped data, data scraper, data crawler.
9393

9494
### Choose how to start your sentences 📝
9595

9696
- _Noun-first (descriptive)_:
97-
- Data extraction tool to extract Airbnb data: host info, prices, dates, location, and reviews.
97+
- Data extraction tool to extract Airbnb data: host info, prices, dates, location, and reviews.
9898
- _Imperative-first (motivating)_:
99-
- Try a free web scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
100-
99+
- Try a free web scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
101100

102101
### Keep it short and SEO-focused ✂️
103102

104103
- _Be concise and direct_: clearly state what your Actor does. Avoid unnecessary fluff and boilerplate text.
105-
- ✅ Scrapes job listings from Indeed and gathers...
106-
-*This Actor scrapes job listings from Indeed in order to gather...
104+
- ✅ Scrapes job listings from Indeed and gathers...
105+
-\*This Actor scrapes job listings from Indeed in order to gather...
107106
- _Optimize for search engines_: include popular keywords related to your Actor’s functionality that users might search for.
108-
- ✅ This Indeed scraper helps you collect job data efficiently. Use the tool to gather...
109-
- ❌ This tool will search through job listings on Indeed and offers you...
110-
107+
- ✅ This Indeed scraper helps you collect job data efficiently. Use the tool to gather...
108+
- ❌ This tool will search through job listings on Indeed and offers you...
111109

112110
### List the data your Actor works with 📝
113111

@@ -123,17 +121,17 @@ Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction
123121
### Highlight your strong suits 🌟
124122

125123
- Ease of use, no coding, user-friendly:
126-
- Easy scraping tool to extract Airbnb data.
124+
- Easy scraping tool to extract Airbnb data.
127125
- Fast and scalable:
128-
- Scrape whole cities or extract data from hundreds of Airbnb rentals in seconds.
126+
- Scrape whole cities or extract data from hundreds of Airbnb rentals in seconds.
129127
- Free (only if the trial run can cover $5 free credits):
130-
- Try a free scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
131-
- Extract host information, locations, availability, stars, reviews, images, and host/guest details for free.
128+
- Try a free scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
129+
- Extract host information, locations, availability, stars, reviews, images, and host/guest details for free.
132130
- Available platform features (various formats, API, integrations, scheduling):
133-
- Export scraped data in formats like HTML, JSON, and Excel.
131+
- Export scraped data in formats like HTML, JSON, and Excel.
134132
- Additional tips:
135-
- Avoid ending lists with etc.
136-
- Consider adding relevant emojis for visual appeal.
133+
- Avoid ending lists with etc.
134+
- Consider adding relevant emojis for visual appeal.
137135

138136
### Break it down 🔠
139137

@@ -146,7 +144,9 @@ Examples:
146144
1. Export scraped data, run the scraper via API, schedule and monitor runs, or integrate with other tools.
147145

148146
## FAQ
147+
149148
<!-- markdownlint-disable MD001 -->
149+
150150
#### Can the Actor's meta description and description be the same?
151151

152152
Yes, they can, as long as they have the same (shorter) length (under 150 characters). But they can also be different - there's no harm in that.

sources/academy/build-and-publish/apify-store-basics/how_actor_monetization_works.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,26 @@ Monetizing your Actor on the Apify platform involves several key steps:
2828
![pay per event model example](images/ppe-model.png)
2929

3030
- _How it works_: you charge users based on specific events triggered programmatically by your Actor's code. You earn 80% of the revenue minus platform usage costs.
31-
- - _Profit calculation_: `profit = (0.8 * revenue) - platform usage costs`
31+
- _Profit calculation_: `profit = (0.8 * revenue) - platform usage costs`
3232
- _Event cost example_: you set the following events for your Actor:
33-
- `Actor start per 1 GB of memory` at $0.005
34-
- `Pages scraped` at $0.002
35-
- `Page opened with residential proxy` at $0.002 - this is on top of `Pages scraped`
36-
- `Page opened with a browser` at $0.002 - this is on top of `Pages scraped`
33+
- `Actor start per 1 GB of memory` at $0.005
34+
- `Pages scraped` at $0.002
35+
- `Page opened with residential proxy` at $0.002 - this is on top of `Pages scraped`
36+
- `Page opened with a browser` at $0.002 - this is on top of `Pages scraped`
3737
- _Example_:
38-
- User A:
39-
- Started the Actor with 10GB of memory = $0.05
40-
- Scraped 1,000 pages = $2.00
41-
- 500 of those were scraped using residential proxy = $1.00
42-
- 300 of those were scraped using browser = $0.60
43-
- This comes up to $3.65 of total revenue
44-
- User B:
45-
- Started the Actor with 5GB of memory = $0.025
46-
- Scraped 500 pages = $1.00
47-
- 200 of those were scraped using residential proxy = $0.40
48-
- 100 of those were scraped using browser = $0.20
49-
- This comes up to $1.625 of total revenue
50-
- That means if platform usage costs are $0.365 for user A and $0.162 for user B your profit is $4.748
38+
- User A:
39+
- Started the Actor with 10GB of memory = $0.05
40+
- Scraped 1,000 pages = $2.00
41+
- 500 of those were scraped using residential proxy = $1.00
42+
- 300 of those were scraped using browser = $0.60
43+
- This comes up to $3.65 of total revenue
44+
- User B:
45+
- Started the Actor with 5GB of memory = $0.025
46+
- Scraped 500 pages = $1.00
47+
- 200 of those were scraped using residential proxy = $0.40
48+
- 100 of those were scraped using browser = $0.20
49+
- This comes up to $1.625 of total revenue
50+
- That means if platform usage costs are $0.365 for user A and $0.162 for user B your profit is $4.748
5151

5252
:::info Pay-per-event details
5353

@@ -62,11 +62,11 @@ If you want more details about PPE pricing, refer to our [PPE documentation](/pl
6262
- _How it works_: you charge users based on the number of results your Actor generates. You earn 80% of the revenue minus platform usage costs.
6363
- _Profit calculation_: `profit = (0.8 * revenue) - platform usage costs`
6464
- _Cost breakdown_:
65-
- Compute unit: $0.3 per CU
66-
- Residential proxies: $13 per GB
67-
- SERPs proxy: $3 per 1,000 SERPs
68-
- Data transfer (external): $0.20 per GB
69-
- Dataset storage: $1 per 1,000 GB-hours
65+
- Compute unit: $0.3 per CU
66+
- Residential proxies: $13 per GB
67+
- SERPs proxy: $3 per 1,000 SERPs
68+
- Data transfer (external): $0.20 per GB
69+
- Dataset storage: $1 per 1,000 GB-hours
7070
- _Example_: you set a price of $1 per 1,000 results. Two users generate 50,000 and 20,000 results, paying $50 and $20, respectively. If the platform usage costs are $5 and $2, your profit is $49.
7171

7272
:::info Pay-per-result details
@@ -81,9 +81,9 @@ If you want more details about PPR pricing, refer to our [PPR documentation](/pl
8181

8282
- _How it works_: you offer a free trial period and set a monthly fee. Users on Apify paid plans can continue using the Actor after the trial. You earn 80% of the monthly rental fees.
8383
- _Example_: you set a 7-day free trial and $30/month rental. If 3 users start using your Actor:
84-
- 1st user on a paid plan pays $30 after the trial (you earn $24).
85-
- 2nd user starts their trial but pays next month.
86-
- 3rd user on a free plan finishes the trial without upgrading to a paid plan and can’t use the Actor further.
84+
- 1st user on a paid plan pays $30 after the trial (you earn $24).
85+
- 2nd user starts their trial but pays next month.
86+
- 3rd user on a free plan finishes the trial without upgrading to a paid plan and can’t use the Actor further.
8787

8888
:::info Rental pricing details
8989

@@ -160,7 +160,7 @@ Example of useful pricing estimates from the **Analytics** tab:
160160

161161
:::tip Use emails!
162162

163-
📫 Don't forget to set an email sequence to warn and remind your users about pricing changes. Learn more about emailing your users here: [Emails to Actor users]
163+
📫 Don't forget to set an email sequence to warn and remind your users about pricing changes. Learn more about emailing your users here: [Emails to Actor users]
164164

165165
:::
166166

@@ -172,4 +172,3 @@ Example of useful pricing estimates from the **Analytics** tab:
172172
- Watch our webinar on how to [build, publish and monetize Actors](https://www.youtube.com/watch?v=4nxStxC1BJM)
173173
- Read a blog post from our CEO on the [reasoning behind monetizing Actors](https://blog.apify.com/make-regular-passive-income-developing-web-automation-actors-b0392278d085/)
174174
- Learn about the [Creator plan](https://apify.com/pricing/creator-plan), which allows you to create and freely test your own Actors for $1
175-

sources/academy/build-and-publish/apify-store-basics/how_to_create_actor_readme.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ If you want to add snippets of code anywhere in your README, you can use [Carbo
173173

174174
If you need quick Markdown guidance, check out [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/)
175175

176-
177176
## README and SEO
178177

179178
Your README is your landing page.
@@ -231,8 +230,8 @@ Learn about [How to create a great input schema](/academy/actor-marketing-playbo
231230
- Business use cases
232231
- Link to a success story, a business use case, or a blog post.
233232
3. How to scrape (target site)
234-
- Link to "How to…" blogs, if one exists (or suggest one if it doesn't)
235-
- Add a video tutorial or gif from an ideal Actor run.
233+
- Link to "How to…" blogs, if one exists (or suggest one if it doesn't)
234+
- Add a video tutorial or gif from an ideal Actor run.
236235

237236
:::tip Embedding YouTube videos
238237

@@ -246,13 +245,13 @@ For better user experience, Apify Console automatically renders every YouTube UR
246245
- This can be used as a boilerplate text for the legal section, but you should use your own judgment and also customize it with the site name.
247246

248247
> Our scrapers are ethical and do not extract any private user data, such as email addresses, gender, or location. They only extract what the user has chosen to share publicly. We therefore believe that our scrapers, when used for ethical purposes by Apify users, are safe. However, you should be aware that your results could contain personal data. Personal data is protected by the GDPR in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so. If you're unsure whether your reason is legitimate, consult your lawyers. You can also read our blog post on the legality of web scraping
249-
>
248+
250249
2. Input
251250
- Each Actor detail page has an input tab, so you just need to refer to that. If you like, you can add a screenshot showing the user what the input fields will look like.
252251
- This is an example of how to refer to the input tab:
253252

254253
> Twitter Scraper has the following input options. Click on the input tab for more information.
255-
>
254+
256255
3. Output
257256
- Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.”
258257
- Add a simplified JSON dataset example, like here https://apify.com/compass/crawler-google-places#output-example

sources/academy/build-and-publish/apify-store-basics/importance_of_actor_url.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,10 @@ In Console. Open the **Actor's page**, then click on **…** in the top right co
8484

8585
![set the actor url](images/how-and-where-to-set-the-actor-url.png)
8686

87-
8887
## FAQ
88+
8989
<!-- markdownlint-disable MD001 -->
90+
9091
#### Can Actor URL be different from Actor name?
9192

9293
Yes. While they can be the same, they don’t have to be. For the best user experience, keeping them identical is recommended, but you can experiment with the Actor's name. Just avoid changing the Actor URL.
@@ -106,4 +107,3 @@ Yes, you can. But it will most likely lower your chances of being noticed by Goo
106107
#### Does changing my Apify account name affect the Actor URL?
107108

108109
Yes. If you're changing from _justanotherdev/pentagon-scraper_ to _dev/pentagon-scraper_, it counts as a new page. Essentially, the consequences are the same as after changing the technical name of the Actor.
109-

sources/academy/build-and-publish/apify-store-basics/name_your_actor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ Ideally, you should choose a name that clearly shows what your Actor does and in
1919
Your Actor's name consists of four parts: actual name, SEO name, URL, and GitHub repository name.
2020

2121
- Actor name (name shown in Apify Store), e.g. _Booking Scraper_.
22-
- Actor SEO name (name shown on Google Search, optional), e.g. _Booking.com Hotel Data Scraper_.
23-
- If the SEO name is not set, the Actor name will be the default name shown on Google.
22+
- Actor SEO name (name shown on Google Search, optional), e.g. _Booking.com Hotel Data Scraper_.
23+
- If the SEO name is not set, the Actor name will be the default name shown on Google.
2424
- Actor URL (technical name), e.g. _booking-scraper_.
25-
- More on it on [Importance of Actor URL](/academy/actor-marketing-playbook/actor-basics/importance-of-actor-url) page.
25+
- More on it on [Importance of Actor URL](/academy/actor-marketing-playbook/actor-basics/importance-of-actor-url) page.
2626
- GitHub repository name (best to keep it similar to the other ones, for convenience), e.g. _actor-booking-scraper_.
2727

2828
## Actor name

0 commit comments

Comments
 (0)