« get me outta code hell

group.md « documents - hsmusic-docs - Unnamed repository; edit this file 'description' to name the repository.
about summary refs log tree commit diff
path: root/documents/group.md
blob: e65f9fe205da344c72de279591df7671413027b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Group Format

Group documents are stored all in one file, `groups.yaml`, one document (entry) per group. They're further categorized by group category documents.

The groups file will, in its entirety, look something like this:

```yaml
Category: HSMusic
Color: '#0088ff'
---
Group: Official Discography
Directory: official
# ...
---
Group: Fandom
# ...
---
Category: Fan-musician groups
Color: '#ffec14'
---
Group: Homestuck Gaiden
URLs:
# ...
---
Group: Unofficial MSPA Fans
URLs:
# ...
```

## Group documents

Referenced as `group:directory`; extra links: `[[group-gallery:directory]]`.

* `Group`: group name
* `Directory`: unique identifier among other groups
* `Description`: any-length description of the group (use `<hr class="split">` for paragraphs beyond the brief summary)
* `URLs`: web URLs where the group can be visited

* `Featured Albums`: optional list of "featured" albums; if present, displayed in a carousel on group gallery page

## Group category documents

* `Category`: group category name
* `Color`: color for category and all included groups