Skip to content

Commit 2ad0c4c

Browse files
authored
docs: add overview page (#510)
Part of the fix for apify/apify-docs#1869
1 parent ca3a4df commit 2ad0c4c

File tree

17 files changed

+394
-2
lines changed

17 files changed

+394
-2
lines changed

docs/overview.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
## What are Actors
10+
11+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
12+
13+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
14+
15+
## Quick start
16+
17+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
18+
19+
```js
20+
import { Actor } from 'apify';
21+
22+
await Actor.init();
23+
24+
const input = await Actor.getInput();
25+
console.log(input);
26+
27+
await Actor.exit();
28+
```
29+
30+
Explore the [Examples](./examples) section to see more of the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::

website/docusaurus.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ module.exports = {
4646
items: [
4747
{
4848
type: 'doc',
49-
docId: 'guides/apify-platform',
49+
docId: 'overview',
5050
label: 'Docs',
5151
position: 'left',
52-
activeBaseRegex: 'guides',
52+
activeBaseRegex: 'guides|overview',
5353
},
5454
{
5555
type: 'doc',

website/sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
module.exports = {
22
docs: [
3+
{
4+
type: 'doc',
5+
label: 'Overview',
6+
id: 'overview',
7+
},
38
{
49
type: 'category',
510
label: 'Guides',
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the guide section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the guide section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
id: overview
3+
title: Apify SDK for JavaScript
4+
sidebar_label: Overview
5+
---
6+
7+
The Apify SDK for JavaScript is the official library for creating [Apify Actors](https://docs.apify.com/platform/actors) using JavaScript or TypeScript. It provides useful features like Actor lifecycle management, local storage emulation, and Actor event handling.
8+
9+
```js
10+
import { Actor } from 'apify';
11+
12+
await Actor.init();
13+
14+
const input = await Actor.getInput();
15+
console.log(input);
16+
17+
await Actor.exit();
18+
```
19+
20+
## What are Actors
21+
22+
Actors are serverless cloud programs capable of performing tasks in a web browser, similar to what a human can do. These tasks can range from simple operations, such as filling out forms or unsubscribing from services, to complex jobs like scraping and processing large numbers of web pages.
23+
24+
Actors can be executed locally or on the [Apify platform](https://docs.apify.com/platform). The Apify platform lets you run Actors at scale and provides features for monitoring, scheduling, publishing, and monetizing them.
25+
26+
## Quick start
27+
28+
To create and run Actors using Apify Console, check out [Apify Console documentation](https://docs.apify.com/platform/console). For creating and running JavaScript Actors locally, refer to the [Apify platform guide](./guides/apify-platform).
29+
30+
Explore the [Examples](./examples) section to see the SDK in action, and refer to the [Guides](./guides) section for a deeper understanding of the SDK's features and best practices.
31+
32+
## Installation
33+
34+
The Apify SDK for JavaScript is typically installed when you create a new Actor project using the [Apify CLI](https://docs.apify.com/cli). To install it manually in an existing project, use:
35+
36+
```bash
37+
npm install apify
38+
```
39+
40+
:::note API client alternative
41+
42+
If you need to interact with the Apify API programmatically without creating Actors, use the [Apify API client for JavaScript](https://docs.apify.com/api/client/js) instead.
43+
44+
:::

0 commit comments

Comments
 (0)