Skip to content

Commit ac9de54

Browse files
committed
add shields doc
1 parent 030e50a commit ac9de54

File tree

2 files changed

+63
-3
lines changed

2 files changed

+63
-3
lines changed

lib/algora_web/live/docs_live.ex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ defmodule AlgoraWeb.DocsLive do
5656
%{
5757
title: "Embed",
5858
links: [
59-
%{title: "SDK", href: "/docs/embed/sdk"}
60-
# %{title: "Shields", href: "/docs/embed/shields"},
61-
# %{title: "OG images", href: "/docs/embed/og-images"}
59+
%{title: "SDK", href: "/docs/embed/sdk"},
60+
%{title: "Shields", href: "/docs/embed/shields"},
61+
%{title: "OG images", href: "/docs/embed/og-images"}
6262
]
6363
},
6464
%{

priv/content/docs/embed/shields.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,63 @@
11
---
22
title: "Shields"
33
---
4+
5+
# Shields
6+
7+
Use these snippets to display your Algora stats on your website, readme etc.
8+
9+
## Examples
10+
11+
<a href="https://algora.io/coollabsio/bounties/new">
12+
<img
13+
src="https://img.shields.io/static/v1?labelColor=grey&color=6366f1&label=Algora&message=%F0%9F%92%8E+Bounty+issues&style=for-the-badge"
14+
alt="Bounty Issues"
15+
/>
16+
</a>
17+
18+
as seen in [Coolify README](https://github.com/coollabsio/coolify)
19+
20+
```html
21+
<a href="https://algora.io/<YOUR_ORG>/bounties/new">
22+
<img
23+
src="https://img.shields.io/static/v1?labelColor=grey&color=6366f1&label=Algora&message=%F0%9F%92%8E+Bounty+issues&style=for-the-badge"
24+
alt="Bounty Issues"
25+
/>
26+
</a>
27+
```
28+
29+
<a href="https://algora.io/cal/bounties?status=open">
30+
<img
31+
src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2Fcal%2Fbounties%3Fstatus%3Dopen"
32+
alt="Open Bounties"
33+
/>
34+
</a>
35+
36+
as seen in [Cal.com README](https://github.com/calcom/cal.com)
37+
38+
```html
39+
<a href="https://algora.io/<YOUR_ORG>/bounties?status=open">
40+
<img
41+
src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2F<YOUR_ORG>%2Fbounties%3Fstatus%3Dopen"
42+
alt="Open Bounties"
43+
/>
44+
</a>
45+
```
46+
47+
<a href="https://algora.io/cal/bounties?status=completed">
48+
<img
49+
src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2Fcal%2Fbounties%3Fstatus%3Dcompleted"
50+
alt="Rewarded Bounties"
51+
/>
52+
</a>
53+
54+
as seen in [Cal.com README](https://github.com/calcom/cal.com)
55+
56+
```html
57+
<a href="https://algora.io/<YOUR_ORG>/bounties?status=completed">
58+
<img
59+
src="https://img.shields.io/endpoint?url=https%3A%2F%2Falgora.io%2Fapi%2Fshields%2F<YOUR_ORG>%2Fbounties%3Fstatus%3Dcompleted"
60+
alt="Rewarded Bounties"
61+
/>
62+
</a>
63+
```

0 commit comments

Comments
 (0)