Apify documentation

May 5, 2026 ยท View on GitHub

Check & Release

Overview

This repository is the home of Apify's documentation, available at docs.apify.com. The documentation uses Markdown and Docusaurus.

Documentation structure

Documentation ecosystem consists of:

Getting started

Before contributing, read these essential resources:

Prerequisites

  • Node.js 22 (see .nvmrc)
  • pnpm 10 (pinned via packageManager in package.json; corepack enable picks it up automatically)
  • Git

Quick setup

# Clone the repository
git clone https://github.com/apify/apify-docs.git
cd apify-docs

# Install dependencies
pnpm install

# Start development server
pnpm start

The site will be available at http://localhost:3000

Available scripts

  • pnpm start - Start development server with API docs
  • pnpm build - Build for production
  • pnpm lint - Run all linting checks
  • pnpm lint:fix - Fix linting issues automatically
  • pnpm api:rebuild - Regenerate API documentation

Documentation architecture

Documentation consists of these main sections:

  1. Academy: Collection of mostly platform-independent courses on scraping techniques.
  2. Platform: Main documentation for using Apify as a product.
  3. API: API reference and client libraries documentation.
  4. SDK: SDK libraries documentation.
  5. CLI: Documentation for building code and platform interaction.

Source repositories

  • apify-docs (this repository)
  • apify-client-js
  • apify-client-python
  • apify-sdk-js
  • apify-sdk-python
  • apify-cli

Architecture

Documentation is built using:

  • Docusaurus: Powers the documentation platform
  • Shared theme: Custom @apify/docs-theme package
  • Automated deployment: CI/CD pipeline for continuous updates
  • nginx routing: Handles subdomain routing and redirects

Need help