This repository was archived by the owner on Feb 4, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +33
-20
lines changed Expand file tree Collapse file tree 2 files changed +33
-20
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ The home page of your CTF can be configured with various content in markdown and
5
5
In addition to normal HTML, you can use some custom elements.
6
6
7
7
* ` <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 ) )
9
9
* ` <action-button></action-button> ` : a button with hover effects, generally used as a link to ` /register `
10
10
11
11
``` yaml
@@ -27,3 +27,35 @@ homeContent: |
27
27
28
28
<sponsors></sponsors>
29
29
` ` `
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
+ ` ` `
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments