diff options
Diffstat (limited to 'documents/group.md')
| -rw-r--r-- | documents/group.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/documents/group.md b/documents/group.md new file mode 100644 index 0000000..e65f9fe --- /dev/null +++ b/documents/group.md @@ -0,0 +1,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 |