Skip to content

Commit

Permalink
docs: Update badge.mdx (#1297)
Browse files Browse the repository at this point in the history
  • Loading branch information
jancurn authored Nov 21, 2024
2 parents a67546f + 3e821f7 commit 134b600
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions sources/platform/actors/publishing/badge.mdx
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
---
title: Actor status badge
description: Apify Actor status badge can be embedded in 3rd party documentation to show current health status and engagement of the Actor in the Apify Platform.
description: The Actor status badge can be embedded in the README or documentation to show users the current status and usage of your Actor on the Apify platform.
slug: /actors/publishing/status-badge
sidebar_position: 4
---

Apify Actor status badge can be embedded in 3rd party documentation to show current health status and engagement of the Actor in the Apify Platform.
The Actor status badge can be embedded in the README or documentation to show users the current status and usage of your Actor on the Apify platform.

---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## Actor status badge example

This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor.
This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor:

[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)

This is how such a badge looks in a GitHub repository README:

![Actor badge in GitHub README](images/github-badge-screenshot.png)


### How to embed the Actor status badge
### How to embed the badge

The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template:

```text
https://apify.com/actor-badge?actor=:username/:actor-name
https://apify.com/actor-badge?actor=<USERNAME>/<ACTOR>
```

In order to embed the badge in the HTML documentation, just use it as an image wrapped in a link as shown in the example below. Don't froget to use the `username` and `actor-name` of your Actor.

#### Example
<!-- vale off -->
<Tabs>
<TabItem value="html" label="HTML Example" default>
<TabItem value="html" label="HTML" default>
```html
<a href="https://apify.com/apify/website-content-crawler">
<img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
</a>
```
</TabItem>
<TabItem value="markdown" label="Markdown Example">
<TabItem value="markdown" label="Markdown">
```markdown
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler)
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
```
</TabItem>
</Tabs>
<!-- vale on -->
### Supported Actor states

The badge indicates the state of the Actor in the Apify Platform as the result of the [automated testing](../development/automated_tests.md).
The badge indicates the state of the Actor in the Apify platform as the result of the [automated testing](../development/automated_tests.md).

#### Actor OK

Expand All @@ -65,7 +67,3 @@ The badge indicates the state of the Actor in the Apify Platform as the result o

![Actor badge not found](./images/actor-badge/not-found.svg)

### Example of the Badge in Github README

![Actor badge in githhub readme](images/github-badge-screenshot.png)

0 comments on commit 134b600

Please sign in to comment.