michael/blowfish
1
0
Fork 0
mirror of https://github.com/nunocoracao/blowfish.git synced 2025-02-02 11:32:30 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

✨ add documentation to the exampleSite

Browse source
This commit is contained in:
Jörn-Michael Miehe 2024-08-07 22:51:38 +02:00
parent 5762ecaf1b
commit 0477c2018d
1 changed files with 44 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
exampleSite/content/docs/shortcodes/index.md
View file

@ -286,6 +286,28 @@ Blowfish also supports automatic conversion of images included using standard Ma
<br/><br/><br/> <br/><br/><br/>
## 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.
<!-- prettier-ignore-start -->
| Parameter | Description |
| --------- | ----------------------------------------------------- |
| `repo` | [String] forgejo repo in the format of `username/repo`|
| `server` | [String] server URL like `https://v8.next.forgejo.org`|
<!-- prettier-ignore-end -->
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" >}}
<br/><br/><br/>
## Gallery ## Gallery
`gallery` allows you to showcase multiple images at once, in a responsive manner with more varied and interesting layouts. `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
<br/><br/><br/> <br/><br/><br/>
## 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.
<!-- prettier-ignore-start -->
| Parameter | Description |
| --------- | ----------------------------------------------------- |
| `repo` | [String] gitea repo in the format of `username/repo` |
| `server` | [String] server URL like `https://git.fsfe.org` |
<!-- prettier-ignore-end -->
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" >}}
<br/><br/><br/>
## GitHub Card ## 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. `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.