Skip to content

Commit 134b600

Browse files
authored
docs: Update badge.mdx (#1297)
2 parents a67546f + 3e821f7 commit 134b600

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed
Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,55 @@
11
---
22
title: Actor status badge
3-
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.
3+
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.
44
slug: /actors/publishing/status-badge
55
sidebar_position: 4
66
---
77

8-
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.
8+
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.
99

1010
---
1111
import Tabs from '@theme/Tabs';
1212
import TabItem from '@theme/TabItem';
1313

14-
## Actor status badge example
15-
16-
This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor.
14+
This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor:
1715

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

18+
This is how such a badge looks in a GitHub repository README:
19+
20+
![Actor badge in GitHub README](images/github-badge-screenshot.png)
21+
2022

21-
### How to embed the Actor status badge
23+
### How to embed the badge
2224

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

2527
```text
26-
https://apify.com/actor-badge?actor=:username/:actor-name
28+
https://apify.com/actor-badge?actor=<USERNAME>/<ACTOR>
2729
```
2830

2931
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.
3032

3133
#### Example
3234
<!-- vale off -->
3335
<Tabs>
34-
<TabItem value="html" label="HTML Example" default>
36+
<TabItem value="html" label="HTML" default>
3537
```html
3638
<a href="https://apify.com/apify/website-content-crawler">
3739
<img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
3840
</a>
3941
```
4042
</TabItem>
41-
<TabItem value="markdown" label="Markdown Example">
43+
<TabItem value="markdown" label="Markdown">
4244
```markdown
43-
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler)
45+
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
4446
```
4547
</TabItem>
4648
</Tabs>
4749
<!-- vale on -->
4850
### Supported Actor states
4951

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

5254
#### Actor OK
5355

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

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

68-
### Example of the Badge in Github README
69-
70-
![Actor badge in githhub readme](images/github-badge-screenshot.png)
71-

0 commit comments

Comments
 (0)