From 0477c2018de2a5b41a4a85cc1d13e0198921da3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rn-Michael=20Miehe?=
<40151420+ldericher@users.noreply.github.com>
Date: Wed, 7 Aug 2024 22:51:38 +0200
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20add=20documentation=20to=20the=20ex?=
=?UTF-8?q?ampleSite?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
exampleSite/content/docs/shortcodes/index.md | 44 ++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md
index 29cb834b..a0c49d0a 100644
--- a/exampleSite/content/docs/shortcodes/index.md
+++ b/exampleSite/content/docs/shortcodes/index.md
@@ -286,6 +286,28 @@ Blowfish also supports automatic conversion of images included using standard Ma
+## Forgejo Card
+
+`forgejo` allows you to quickly link a Forgejo repository via the forgejo API, providing real-time updates on stats such as stars and forks.
+
+
+| Parameter | Description |
+| --------- | ----------------------------------------------------- |
+| `repo` | [String] forgejo repo in the format of `username/repo`|
+| `server` | [String] server URL like `https://v8.next.forgejo.org`|
+
+
+A default value for `server` may be provided in `params.toml` as `.Site.Params.forgejoDefaultServer`.
+
+**Example 1:**
+
+```md
+{{* forgejo server="https://v8.next.forgejo.org" repo="forgejo/forgejo" */>}}
+```
+{{< forgejo server="https://v8.next.forgejo.org" repo="forgejo/forgejo" >}}
+
+
+
## Gallery
`gallery` allows you to showcase multiple images at once, in a responsive manner with more varied and interesting layouts.
@@ -345,6 +367,28 @@ In order to add images to the gallery, use `img` tags for each image and add `cl
+## Gitea Card
+
+`gitea` allows you to quickly link a Gitea repository via the gitea API, providing real-time updates on stats such as stars and forks.
+
+
+| Parameter | Description |
+| --------- | ----------------------------------------------------- |
+| `repo` | [String] gitea repo in the format of `username/repo` |
+| `server` | [String] server URL like `https://git.fsfe.org` |
+
+
+A default value for `server` may be provided in `params.toml` as `.Site.Params.giteaDefaultServer`.
+
+**Example 1:**
+
+```md
+{{* gitea server="https://git.fsfe.org" repo="FSFE/fsfe-website" */>}}
+```
+{{< gitea server="https://git.fsfe.org" repo="FSFE/fsfe-website" >}}
+
+
+
## GitHub Card
`github` allows you to quickly link a github repository, all while showing and updating in realtime stats about it, such as the number of stars and forks it has.