Skip to content

Commit c35afb7

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

File tree

258 files changed

+7690
-7943
lines changed

Some content is hidden

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

258 files changed

+7690
-7943
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: 11 additions & 11 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

@@ -84,11 +84,11 @@ When writing a description, less is more. You only have a few seconds to capture
8484
- name: Airbnb Scraper
8585
- 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
87+
Include variations, e.g. Airbnb API, Airbnb data, Airbnb data scraper, Airbnb rentals, Airbnb listings
8888
- No-code scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
8989
- 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
91+
Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction tool, extract data, get data
9292
- Scrape XYZ data, scraped data, data scraper, data crawler.
9393

9494
### Choose how to start your sentences 📝
@@ -98,17 +98,15 @@ Use terms, e.g. crawl, crawler, scraping tool, finder, scraper, data extraction
9898
- _Imperative-first (motivating)_:
9999
- Try a free web scraping tool to extract Airbnb data: host info, prices, dates, location, and reviews.
100100

101-
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.
105104
- ✅ Scrapes job listings from Indeed and gathers...
106-
-*This Actor scrapes job listings from Indeed in order to gather...
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.
108107
- ✅ This Indeed scraper helps you collect job data efficiently. Use the tool to gather...
109108
- ❌ This tool will search through job listings on Indeed and offers you...
110109

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

114112
- Data extraction tool to extract Airbnb data: host info, prices, dates, location, and reviews.
@@ -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: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ 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:
3333
- `Actor start per 1 GB of memory` at $0.005
3434
- `Pages scraped` at $0.002
@@ -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: 16 additions & 17 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.
@@ -223,13 +222,13 @@ Learn about [How to create a great input schema](/academy/actor-marketing-playbo
223222
## Readme elements template
224223

225224
1. What does (Actor name) do?
226-
- in 1–2 sentences describe what the Actor does and what it does not do
227-
- consider adding keywords like API, e.g. Instagram API
228-
- always have a link to the target website in this section
225+
- in 1–2 sentences describe what the Actor does and what it does not do
226+
- consider adding keywords like API, e.g. Instagram API
227+
- always have a link to the target website in this section
229228
2. Why use (Actor name)? or Why scrape (target site)?
230-
- How it can be beneficial for the user
231-
- Business use cases
232-
- Link to a success story, a business use case, or a blog post.
229+
- How it can be beneficial for the user
230+
- Business use cases
231+
- Link to a success story, a business use case, or a blog post.
233232
3. How to scrape (target site)
234233
- Link to "How to…" blogs, if one exists (or suggest one if it doesn't)
235234
- Add a video tutorial or gif from an ideal Actor run.
@@ -243,21 +242,21 @@ For better user experience, Apify Console automatically renders every YouTube UR
243242
- Consider adding a short numbered tutorial, as Google will sometimes pick these up as rich snippets. Remember that this might be in search results, so you can repeat the name of the Actor and give a link, e.g.
244243

245244
1. Is it legal to scrape (target site)?
246-
- 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.
245+
- 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.
246+
247+
> 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
247248
248-
> 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-
>
250249
2. Input
251-
- 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.
252-
- This is an example of how to refer to the input tab:
250+
- 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.
251+
- This is an example of how to refer to the input tab:
252+
253+
> Twitter Scraper has the following input options. Click on the input tab for more information.
253254
254-
> Twitter Scraper has the following input options. Click on the input tab for more information.
255-
>
256255
3. Output
257-
- Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.”
258-
- Add a simplified JSON dataset example, like here https://apify.com/compass/crawler-google-places#output-example
256+
- Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.”
257+
- Add a simplified JSON dataset example, like here https://apify.com/compass/crawler-google-places#output-example
259258
4. Tips or Advanced options section
260-
- Share any tips on how to best run the Actor, such as how to limit compute unit usage, get more accurate results, or improve speed.
259+
- Share any tips on how to best run the Actor, such as how to limit compute unit usage, get more accurate results, or improve speed.
261260

262261
If you want some general tips on how to make a GitHub README that stands out, check out these guides. Not everything in there will be suitable for an Apify Actor README, so you should cherry-pick what you like and use your imagination.
263262

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ There's an option to step away from your Actor's name for the sake of search eng
4141

4242
- _Actor name_: this is the name visible in Apify Store and Console. It should be easy for users to understand and quickly show what your Actor does. It’s about attracting users who browse the Store.
4343

44-
![actor name example](images/actor-name.png)
44+
![actor name example](images/actor-name.png)
4545

4646
- _Actor SEO name_: this is the name that appears in search engine results. It should include keywords people might search for to find your Actor. It’s about improving visibility on search engines and encouraging users to click on your link.
4747

48-
![actor seo name example](images/actor-seo-name.png)
48+
![actor seo name example](images/actor-seo-name.png)
4949

5050
For example:
5151

sources/academy/build-and-publish/how-to-build/how_to_create_a_great_input_schema.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Unfortunately, when it comes to UX, there's only so much you can achieve armed w
6868
- **`description` at the top**
6969
- As the first thing users see, the description needs to provide crucial information and a sense of reassurance if things go wrong. Key points to mention: the easiest way to try the Actor, links to a guide, and any disclaimers or other similar Actors to try.
7070

71-
![Input schema description example](images/description-sshot.png)
71+
![Input schema description example](images/description-sshot.png)
7272

7373
- Descriptions can include multiple paragraphs. If you're adding a link, it’s best to use the `target_blank` property so your user doesn’t lose the original Actor page when clicking.
7474

@@ -90,14 +90,13 @@ Unfortunately, when it comes to UX, there's only so much you can achieve armed w
9090
- How would you word this toggle: **Skip closed places** or **Scrape open places only**? And should the toggle be enabled or disabled by default?
9191

9292
![Input schema toggle example](images/toggle-sshot.png)
93-
9493
- You have to consider this when you're choosing how to word the toggle button and which choice to set up as the default. If you're making this more complex than it's needed (e.g. by using negation as the ‘yes’ choice), you're increasing your user's cognitive load. You also might get them to receive way less, or way more, data than they need from a default run.
9594
- In our example, we assume the default user wants to scrape all places but still have the option to filter out closed ones. However, they have to make that choice consciously, so we keep the toggle disabled by default. If the toggle were enabled by default, users might not notice it, leading them to think the tool isn't working properly when it returns fewer results than expected.
9695

9796
- **sections or `sectionCaption` (BIG bold text) and `sectionDescription`**
9897
- A section looks like a wrapped toggle list.
9998

100-
![Input schema sections example](images/sections-sshot.png)
99+
![Input schema sections example](images/sections-sshot.png)
101100

102101
- It is useful to section off non-default ways of input or extra features. If your tool is complex, don't leave all fields in the first section. Just group them by topic and section them off (see the screenshot above ⬆️)
103102
- You can add a description to every section. Use `sectionDescription` only if you need to provide extra information about the section (see the screenshot below ⬇️.
@@ -165,7 +164,7 @@ The version above was the improved input schema. Here's what this tool's input s
165164

166165
- _User feedback_. If they're asking obvious things, complaining, or consistently making silly mistakes with input, take notes. Feedback from users can help you understand their experience and identify areas for improvement.
167166
- _High churn rates_. If your users are trying your tool but quickly abandon it, this is a sign they are having difficulties with your schema.
168-
- _Input Schema Viewer_. Write your base schema in any code editor, then copy the file and put it into [**Input Schema Viewer](https://console.apify.com/actors/UHTe5Bcb4OUEkeahZ/source).** This tool should help you visualize your Input Schema before you add it to your Actor and build it. Seeing how your edits look in Apify Console right away will make the process of editing the fields in code easier.
167+
- _Input Schema Viewer_. Write your base schema in any code editor, then copy the file and put it into [\*\*Input Schema Viewer](https://console.apify.com/actors/UHTe5Bcb4OUEkeahZ/source).\*\* This tool should help you visualize your Input Schema before you add it to your Actor and build it. Seeing how your edits look in Apify Console right away will make the process of editing the fields in code easier.
169168

170169
## Resources
171170

0 commit comments

Comments
 (0)