Skip to content
This repository was archived by the owner on Feb 4, 2025. It is now read-only.

Commit ad04639

Browse files
pr0PMethanwu10
authored andcommitted
docs: add docs for sponsors cards
Added description about the options that were missing.
1 parent 4c6010e commit ad04639

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

docs/content/management/home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The home page of your CTF can be configured with various content in markdown and
55
In addition to normal HTML, you can use some custom elements.
66

77
* `<timer></timer>`: a countdown timer until the beginning or end of the CTF
8-
* `<sponsors></sponsors>`: a list of sponsor cards
8+
* `<sponsors></sponsors>`: a list of sponsor cards [to configure the sponsors card look here](sponsors.md)
99
* `<action-button></action-button>`: a button with hover effects, generally used as a link to `/register`
1010

1111
```yaml

docs/content/management/sponsors.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Sponsors Card
2+
The sponsors card can be configured with the options:
3+
4+
```yaml
5+
sponsors:
6+
# This is a key value type of array in yaml
7+
# start of array
8+
-
9+
name: # name of sponsor
10+
icon: # link of sponsor's icon
11+
description: # description of the sponsor
12+
small: # true to edit size of the card if you don't include this the default
13+
# size will be used
14+
# second sponsor, include as many as you need
15+
-
16+
name:
17+
icon:
18+
description:
19+
```

0 commit comments

Comments
 (0)