Skip to content

docs: Update badge.mdx #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 21, 2024
Merged

docs: Update badge.mdx #1297

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2968541
Update badge.mdx
jancurn Nov 20, 2024
8e8bb8f
Update badge.mdx
jancurn Nov 20, 2024
3e821f7
Update badge.mdx
jancurn Nov 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions sources/platform/actors/publishing/badge.mdx
View file
Open in desktop
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)

Loading