luzifer/discord-community
1
0
Fork 0
mirror of https://github.com/Luzifer/discord-community.git synced 2024-11-09 15:40:03 +00:00
Code Issues Projects Releases Wiki Activity

Add docs generator 

Signed-off-by: Knut Ahlers <knut@ahlers.me>
Knut Ahlers 2021-07-25 14:26:45 +02:00
parent e3161bb960
commit 20fd0be5c8
2 changed files with 43 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Home.md

@ -1 +1,26 @@
Welcome to the discord-community wiki!
# Discord-Community
## Modules
### schedule
Posts stream schedule derived from Twitch schedule as embed in Discord channel
| Attribute | Required | Type | Default Value | Description |
| --------- | -------- | ---- | ------------- | ----------- |
| `discord_channel_id` | ✅ | string | | ID of the Discord channel to post the message to |
| `embed_title` | ✅ | string | | Title of the embed (used to find the managed post, must be unique for that channel) |
| `twitch_channel_id` | ✅ | string | | ID (not name) of the channel to fetch the schedule from |
| `twitch_client_id` | ✅ | string | | Twitch client ID the token was issued for |
| `twitch_token` | ✅ | string | | Token for the user the `twitch_channel_id` belongs to |
| `cron` | | string | `*/10 * * * *` | When to execute the schedule transfer |
| `embed_color` | | int64 | `3066993` | Integer representation of the hex color for the embed (default is #2ECC71) |
| `embed_description` | | string | | Description for the embed block |
| `embed_thumbnail_height` | | int64 | | Height of the thumbnail |
| `embed_thumbnail_url` | | string | | Publically hosted image URL to use as thumbnail |
| `embed_thumbnail_width` | | int64 | | Width of the thumbnail |
| `schedule_entries` | | int64 | `5` | How many schedule entries to add to the embed as fields |
| `schedule_past_time` | | duration | `15m` | How long in the past should the schedule contain an entry |
<!-- vim: set ft=markdown : -->

17
Home.md.tpl Normal file

@ -0,0 +1,17 @@
# Discord-Community
## Modules
{% for module in modules -%}
### {{ module.type }}
{{ module.description }}
| Attribute | Required | Type | Default Value | Description |
| --------- | -------- | ---- | ------------- | ----------- |
{%- for attr in module.attributes %}
| `{{ attr.name }}` | {% if attr.required == 'required' %}✅{% endif %} | {{ attr.type }} | {% if attr.default != "" %}`{{ attr.default }}`{% endif %} | {{ attr.description }} |
{%- endfor %}
{% endfor %}
<!-- vim: set ft=markdown : -->