anarmammad/apify-docs

This project is a 🏠home of Apify documentation.

Apify documentation

Intro

This project is a home of Apify documentation that you can find running at docs.apify.com. Documentation is written in a Markdown format and all of its source files are located in a /docs directory.

Deployment

On each commit to the master branch of this repository, a new version of Apify documentation gets built and deployed to docs.apify.com.

On commit to any other branch a develop version of docs gets updated. This version can be viewed using a ?version=develop parameter, i.e. at https://docs.apify.com?version=develop.

Keep in mind that there might be about 2 minute delay before updated documentation gets online (1 minute Github actions build + 1 minute update interval of docs website).

Implementation

Metadata

Each Markdown file here starts with metadata that define menu title, placement and page description. For example:

---
title: Quick start
description: Documentation of Apify actors - a serverless computing jobs that enable execution of long-running web scraping and automation tasks in the cloud.
menuWeight: 3.1
---

Assets

You can place assets (images for example) in any directory. If you want to obtain a URL them use following tag:

{{@asset actor/images/run-log-2.png}}

So to include this image in Markdown use:

![Apify actor run log]({{@asset actor/images/run-log-2.png}})

Linking

For links we use similar syntax as for assets:

{{@link actor/source_code.md#source-git-repo}}