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

Commit 2e9c46b

Browse files
committed
docs: reformat sponsor card docs
Move sponsor card documentation into home page configuration page, and reformat as a table of property values and an example configuration.
1 parent ad04639 commit 2e9c46b

File tree

2 files changed

+33
-20
lines changed

2 files changed

+33
-20
lines changed

docs/content/management/home.md

Lines changed: 33 additions & 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 [to configure the sponsors card look here](sponsors.md)
8+
* `<sponsors></sponsors>`: a list of sponsor cards ([see configuration](#sponsor-cards))
99
* `<action-button></action-button>`: a button with hover effects, generally used as a link to `/register`
1010

1111
```yaml
@@ -27,3 +27,35 @@ homeContent: |
2727
2828
<sponsors></sponsors>
2929
```
30+
31+
## Sponsor Cards
32+
33+
The `<sponsors>` element can be used to display cards for the sponsors listed in
34+
the config under `sponsors`.
35+
36+
### Configuration
37+
38+
The `sponsors` key takes an array of sponsor elements, which are each an object
39+
with the following properties:
40+
41+
| Key | Default | Description |
42+
| ------------- | -------- | --------------------------------- |
43+
| `name` | _(none)_ | sponsor name |
44+
| `icon` | _(none)_ | sponsor icon URL |
45+
| `description` | _(none)_ | sponsor description |
46+
| `small` | `false` | whether to show as a compact card |
47+
48+
### Example
49+
50+
```yaml
51+
sponsors:
52+
- name: Foo
53+
icon: https://example.com/foo.png
54+
description: |
55+
An excellent sponsor
56+
- name: Bar
57+
icon: https://example.com/bar.png
58+
description: |
59+
An excellent sponsor
60+
small: true
61+
```

docs/content/management/sponsors.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)