` is returned.
General example:
@@ -810,11 +779,12 @@ Type of variable: **{{ printf "%T" $x }}**
### templates.SDict{#templates-sdict}
-`templates.SDict` - This is a custom composite data type defined on an underlying data type _map\[string]interface{}._
-This is of kind _map_ having _string_ type as its key and _interface{}_ type as that key's value and can be initialized
-using `sdict` function. A map is key-value store. This means you store value and you access that value by a key. Map is
-an unordered list and the number of parameters to form key-value pairs must be even, difference to regular _map_ is that
-`templates.SDict` is ordered by its key. Retrieving specific element inside _templates.Sdict_ is by indexing its key.
+`templates.SDict` - This is a custom composite data type defined on an underlying data type _map\[string]interface{}_.
+This is of kind _map_ having _string_ type as its key and _interface{}_ type as that key's value and can be initialized using `sdict` function.
+A map is a key-value store.
+This means you store value and you access that value by a key.
+A map is an unordered list and the number of parameters to form key-value pairs must be even, difference to regular _map_ is that `templates.SDict` is ordered by its key.
+Retrieving specific element inside _templates.Sdict_ is by indexing its key.
| Function | Description |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -837,32 +807,27 @@ Deleting key "color1" {{ $x.Del "color1" }} and whole sdict: **{{ $x }}**
{{< callout context="tip" title="Tip: Database Serialization" icon="outline/rocket" >}}
-Previously, when saving cslices, sdicts, and dicts into database, they were serialized into their underlying native
-types - slices and maps. This meant that if you wanted to get the custom type back, you needed to convert manually, e.g.
-`{{cslice.AppendSlice $dbSlice}}` or `{{sdict $dbDict}}`. Recent changes to YAG have changed this: values with custom
-types are now serialized properly, making manual conversion unnecessary.
+Previously, when saving cslices, sdicts, and dicts into database, they were serialized into their underlying native types---slices and maps.
+This meant that if you wanted to get the custom type back, you needed to convert manually, e.g. `{{cslice.AppendSlice $dbSlice}}` or `{{sdict $dbDict}}`.
+Recent changes to YAG have changed this: values with custom types are now serialized properly, making manual conversion unnecessary.
{{< /callout >}}
## Database
-You have access to a basic set of Database functions having return of type _\*customcommands.LightDBEntry_ called here
-[DBEntry](#dbentry). This is almost a key value store ordered by the key and value combined.
+You have access to a basic set of Database functions having return of type _\*customcommands.LightDBEntry_ called here [DBEntry](#dbentry).
+This is almost a key value store ordered by the key and value combined.
-You can have max 50 \* user_count (or 500 \* user_count for premium) values in the database, if you go above this all
-new write functions will fail, this value is also cached, so it won't be detected immediately when you go above nor
-immediately when you're under again.
+You can have max 50 \ * user_count (or 500 \* user_count for premium) values in the database, if you go above this all new write functions will fail, this value is also cached, so it won't be detected immediately when you go above nor immediately when you're under again.
-Patterns are basic PostgreSQL patterns, not RegEx: An underscore `(_)` matches any single character; a percent sign
-`(%)` matches any sequence of zero or more characters.
+Patterns are basic PostgreSQL patterns, not RegEx: An underscore `(_)` matches any single character; a percent sign `(%)` matches any sequence of zero or more characters.
-Keys can be max 256 bytes long and has to be strings or numbers. Values can be anything, but if their serialized
-representation exceeds 100kB a `short write` error gets raised.
+Keys can be max 256 bytes long and has to be strings or numbers.
+Values can be anything, but if their serialized representation exceeds 100kB a `short write` error gets raised.
You can just pass a `userID`of 0 to make it global (or any other number, but 0 is safe).
-There can be 10 database interactions per CC, out of which dbTop/BottomEntries, dbCount, dbGetPattern, and dbDelMultiple
-may only be run twice. (50,10 for premium users).
+There can be 10 database interactions per CC, out of which dbTop/BottomEntries, dbCount, dbGetPattern, and dbDelMultiple may only be run twice. (50,10 for premium users).
See also the [chapter on the database](/learn/intermediate/database) in the learning resources.
@@ -905,12 +870,12 @@ See [`createTicket`](functions#createticket) for creating a ticket.
## Time
-Time and duration types use [Go's time package](https://golang.org/pkg/time/#Time). Go by Example lists [some examples
-of using *time.Time*](https://gobyexample.com/time) in Go code, which can be referenced for similar use in YAGPDB's
-templates.
+Time and duration types use [Go's time package](https://golang.org/pkg/time/#Time).
+Go by Example lists [some examples of using *time.Time*](https://gobyexample.com/time) in Go code, which can be referenced for similar use in YAGPDB's templates.
-Some time types in the data that Discord API functions return instead use the *discordgo.Timestamp* type. These can be
-converted to *time.Time* with the `.Parse` method. These cases are mentioned in the type documentation on this page.
+Some time types in the data that Discord API functions return instead use the *discordgo.Timestamp* type.
+These can be converted to *time.Time* with the `.Parse` method.
+These cases are mentioned in the type documentation on this page.
| Field | Description |
| ------------- | ----------------------------------------------------------------------------------------------------------- |
diff --git a/content/docs/roles/autorole.md b/content/docs/roles/autorole.md
index c0eb47d8..a04a1b17 100644
--- a/content/docs/roles/autorole.md
+++ b/content/docs/roles/autorole.md
@@ -6,15 +6,14 @@ description = "Automatically assign roles to members when they join."
{{< callout context="note" title="Note: Required Permissions" icon="outline/info-circle" >}}
-Make sure that the bot has permission to manage roles **and** that the role the bot is assigning is below the highest
-role the bot has.
+Make sure that the bot has permission to manage roles **and** that the role the bot is assigning is below the highest role the bot has.
{{< /callout >}}
{{< callout context="caution" title="Warning: Discord Verification Levels" icon="outline/alert-triangle" >}}
-Be careful when using autorole to automatically give new members roles. Discord's in-built new member verification only
-works on members with no roles, rendering it useless if members are given roles right after they join.
+Be careful when using autorole to automatically give new members roles.
+Discord's in-built new member verification only works on members with no roles, rendering it useless if members are given roles right after they join.
{{< /callout >}}
@@ -32,14 +31,12 @@ The different parameters you can set up on this site are:
them they will not be given a role.
- **Ignore people with the following roles**: If a person has one of the following roles on them they will not be given
a role.
-- **Only assign role when they join, do not give it back if it's removed from them afterwards**: Only assign the role to
- them once when they joined. If they lose the role sometime after, the bot will not give it back to them. Note that
- this means what it says - if this option is unticked and you remove this role manually from someone, it will be given
- back automatically.
+- **Only assign role when they join, do not give it back if it's removed from them afterwards**: Only assign the role to them once when they joined.
+ If they lose the role sometime after, the bot will not give it back to them.
+ Note that this means what it says - if this option is unticked and you remove this role manually from someone, it will be given back automatically.
- **Only assign the role after a member has completed Discord's Membership Screening**: The autorole will only assign
the set role after member has completed the server's Membership Screening.
### Retroactive full scan
-This feature is only available for premium users and it scans the server completely, assigning the autorole to the
-eligible members (if they don't have the role already).
+This feature is only available for premium users and it scans the server completely, assigning the autorole to the eligible members (if they don't have the role already).
diff --git a/content/docs/roles/bulk-role.md b/content/docs/roles/bulk-role.md
index 0b833fae..423c574a 100644
--- a/content/docs/roles/bulk-role.md
+++ b/content/docs/roles/bulk-role.md
@@ -4,24 +4,21 @@ weight = 730
description = "Assign or remove roles to/from multiple members at once."
+++
-
{{< callout context="caution" title="Warning: Required Bot Permissions" icon="outline/alert-triangle" >}}
-Make sure that the bot has permission to manage roles **and** that the role the bot is assigning is below the highest
-role the bot has.
+Make sure that the bot has permission to manage roles **and** that the role the bot is assigning is below the highest role the bot has.
{{< /callout >}}
-Bulk role allows you to assign---or remove---a role en masse. YAGPDB provides several filters to narrow down assignment,
-which will be further explained below. You can only run one bulk role proess at any given time, so you'll have to either
-wait until the current one completes or simply just cancel it.
+Bulk role allows you to assign---or remove---a role en masse.
+YAGPDB provides several filters to narrow down assignment, which will be further explained below.
+You can only run one bulk role proess at any given time, so you'll have to either wait until the current one completes or simply just cancel it.
{{< callout context="note" title="Note: Premium Only" icon="outline/info-circle" >}}
-Due to the nature of this operation requiring a lot of API calls to Discord and the associated cost with that, we
-provide this as a premium-only feature.
+Due to the nature of this operation requiring a lot of API calls to Discord and the associated cost with that, we provide this as a premium-only feature.
{{< /callout >}}
@@ -29,7 +26,8 @@ provide this as a premium-only feature.
### Target Role
-Select the role that you wish to assign or remove. Make sure that the bot's highest role is above this selected role.
+Select the role that you wish to assign or remove.
+Make sure that the bot's highest role is above this selected role.
### Operation
@@ -41,17 +39,17 @@ Select the role that you wish to assign or remove. Make sure that the bot's high
- **All members**: Assign or remove the target role to/from all members indiscriminately.
- **Bots only**: Assign or remove the target role only to/from bots.
- **Humans only**: Assign or remove the target role only to/from humans.
-- **Has specific roles**: Only care about members with at least one of these roles. Optionally you can tell the bot to
- require **all** of your selected roles.
-- **Missing specific roles**: Like the above, but only on members without at least one of these roles. Optionally for
- **all** selected roles.
+- **Has specific roles**: Only care about members with at least one of these roles.
+ Optionally you can tell the bot to require **all** of your selected roles.
+- **Missing specific roles**: Like the above, but only on members without at least one of these roles.
+ Optionally for **all** selected roles.
- **Joined after date**: Only care about members that joined after the selected date.
- **Joined before date**: Only care about members that joined before the selected date.
### Notification Channel
-Optionally select a channel you wish to receive notifications about the operation status of bulk assignment. The bot
-will let you know when it encountered an error during processing, otherwise after it wholly completed it.
+Optionally select a channel you wish to receive notifications about the operation status of bulk assignment.
+The bot will let you know when it encountered an error during processing, otherwise after it wholly completed it.
-After you've configured everything to your liking, click the green "start" button and let the magic happen. If you
-changed your mind, you can always cancel it during the processing.
+After you've configured everything to your liking, click the green "start" button and let the magic happen.
+If you changed your mind, you can always cancel it during the processing.
diff --git a/content/docs/roles/self-assignable-roles.md b/content/docs/roles/self-assignable-roles.md
index 0afc5fbd..4ec44aed 100644
--- a/content/docs/roles/self-assignable-roles.md
+++ b/content/docs/roles/self-assignable-roles.md
@@ -14,15 +14,14 @@ description = "how2 reaction role"
{{< callout context="caution" title="Warning: Required Bot Permissions" icon="outline/alert-triangle" >}}
-Make sure that the bot has the _manage role_ permission and that the bot's role is **above** the role it is trying to
-assign.
+Make sure that the bot has the _manage role_ permission and that the bot's role is **above** the role it is trying to assign.
{{< /callout >}}
{{< callout context="caution" title="Warning: Required User Permissions" icon="outline/alert-triangle" >}}
-If you want to use any of the `rolemenu` commands, you **need** to have the `MANAGE_GUILD` permission, or the
-Manage Server permission. This is hard-coded, meaning that command overrides will not affect it.
+If you want to use any of the `rolemenu` commands, you **need** to have the `MANAGE_GUILD` permission, or the Manage Server permission.
+This is hard-coded, meaning that command overrides will not affect it.
{{< /callout >}}
@@ -34,8 +33,8 @@ Simply give the role command a name and then select which role you want the bot
{{< callout context="caution" title="Warning: Required and Ignored Roles" icon="outline/alert-triangle" >}}
-Do **not** set the required role to the role you are assigning. You generally will not want to set the ignore role to
-the role you are assigning either, _unless_ you wish to prevent the user from removing that role through the role-menu.
+Do **not** set the required role to the role you are assigning.
+You generally will not want to set the ignore role to the role you are assigning either, _unless_ you wish to prevent the user from removing that role through the role-menu.
{{< /callout >}}
@@ -45,12 +44,11 @@ the role you are assigning either, _unless_ you wish to prevent the user from re
## Role Groups
-Role groups are useful for applying restrictions on a group of roles such as only being able to have one or the other
-role etc. They're also essential if you want to create a role menu. To create one, simply give the role group a name and
-then select which mode you want the role group to use.
+Role groups are useful for applying restrictions on a group of roles such as only being able to have one or the other role etc. They're also essential if you want to create a role menu.
+To create one, simply give the role group a name and then select which mode you want the role group to use.
-Every role group, even Ungrouped has the option to delete all roles inside that group, other groups will not be
-affected. Be careful with that, it's permanent and can't be undone.
+Every role group, even Ungrouped has the option to delete all roles inside that group, other groups will not be affected.
+Be careful with that, it's permanent and can't be undone.
They're essential if you want to create a role menu.
@@ -66,8 +64,8 @@ They're essential if you want to create a role menu.
{{< callout context="caution" title="Warning: Required and Ignored Roles" icon="outline/alert-triangle" >}}
-Do **not** set the required role to the role you are assigning. You generally will not want to set the ignore role to
-the role you are assigning either, _unless_ you wish to prevent the user from removing that role through the rolemenu.
+Do **not** set the required role to the role you are assigning.
+You generally will not want to set the ignore role to the role you are assigning either, _unless_ you wish to prevent the user from removing that role through the rolemenu.
{{< /callout >}}
@@ -82,21 +80,23 @@ Role groups have additional options that can be enabled/disabled by selecting th
#### Example usage
-Say you have a server with 3 factions and want people to be able to assign their own faction when they join. That's
-simple enough - all we have to do is:
+Say you have a server with 3 factions and want people to be able to assign their own faction when they join.
+That's simple enough - all we have to do is:
- Create the 3 roles
- Create 3 role commands for those roles
-Now everyone can assign themselves a faction! There are a couple of issues with this setup though:
+Now everyone can assign themselves a faction!
+There are a couple of issues with this setup though:
1. You can assign yourself more than 1 faction.
2. People can freely jump between factions.
-To fix these problems we can create a new group with the mode `Single` and assign the previous role commands to that
-group. Great! Now we can only have 1 faction! How can we solve jumping between factions then? You can enable the
-`Require 1 role in group` setting, now they can't remove roles in the group, and they can have max. 1 role in the group,
-so they can't jump around anymore!
+To fix these problems we can create a new group with the mode `Single` and assign the previous role commands to that group.
+Great!
+Now we can only have 1 faction!
+How can we solve jumping between factions then?
+You can enable the `Require 1 role in group` setting, now they can't remove roles in the group, and they can have max. 1 role in the group, so they can't jump around anymore!
### Adding roles to the role group
@@ -106,49 +106,44 @@ Roles can only be assigned to one group.
{{< /callout >}}
-Refer back to the [optional features for roles](#command-configuration) and select the role group you want to assign
-the role to.
+Refer back to the [optional features for roles](#command-configuration) and select the role group you want to assign the role to.
## Role Menu
{{< callout context="caution" title="Warning: Required Setup" icon="outline/alert-triangle" >}}
-Make sure you created your [role commands](#role-commands) and assigned them a [role group](#role-groups) before
-starting. Role menu will **not** work if you have not done so.
+Make sure you created your [role commands](#role-commands) and assigned them a [role group](#role-groups) before starting.
+Role menu will **not** work if you have not done so.
{{< /callout >}}
-The role menu makes it possible to have people assign roles by adding reactions to a message. If you'd like to create a
-message like in the example to create a rolemenu on, take a look at the [Custom Embeds](/docs/reference/custom-embeds)
-chapter.
+The role menu makes it possible to have people assign roles by adding reactions to a message.
+If you'd like to create a message like in the example to create a rolemenu on, take a look at the [Custom Embeds](/docs/reference/custom-embeds) chapter.
{{< callout context="note" title="Note: Message Reactions Limit" icon="outline/info-circle" >}}
A role menu can only support up to 20 roles due to the reaction limit discord places on messages.
-If your role group has more than twenty you have to use the `rolemenu finish` sub-command and then add the rest of roles
-to a new message using the `-skip` flag.
+If your role group has more than twenty you have to use the `rolemenu finish` sub-command and then add the rest of roles to a new message using the `-skip` flag.
{{< /callout >}}
-To set up a role menu, the related roles **have to be added to a role group**, then you invoke the command
-`-rolemenu create (role group name)`.
+To set up a role menu, the related roles **have to be added to a role group**, then you invoke the command `-rolemenu create (role group name)`.
The group mode and other restrictions from the role group and role still apply to the roles in the role menu.
-After you type in the command, you will be taken through the setup process. If you want to disable DMs, create a custom
-message, or add new role to your role menu, be sure to read until the end.
+After you type in the command, you will be taken through the setup process.
+If you want to disable DMs, create a custom message, or add new role to your role menu, be sure to read until the end.
### Step by step tutorial
-Make sure you created your [role commands](#role-commands) and assigned them a [role group](#role-groups) before
-starting. Role menu will **not** work if you have not done so. All switches and flags (nodm, rr, etc...) start with
-hyphen symbol `-`, not your prefix.
+Make sure you created your [role commands](#role-commands) and assigned them a [role group](#role-groups) before starting.
+Role menu will **not** work if you have not done so.
+All switches and flags (nodm, rr, etc...) start with hyphen symbol `-`, not your prefix.
-Once you've made your role commands and assigned them to a role group, go to the channel in Discord where you want the
-role menu to be created. Then type `-rolemenu create (group name)`; applying our "Sports" role group example, we'd have
-to send `-rolemenu create Sports`.
+Once you've made your role commands and assigned them to a role group, go to the channel in Discord where you want the role menu to be created.
+Then type `-rolemenu create (group name)`; applying our "Sports" role group example, we'd have to send `-rolemenu create Sports`.
@@ -166,31 +161,27 @@ And similar for the final role, **Basketball:**
And we're done---people can start using the menu by clicking on the reaction associated with their desired role.
-The setup message will be automatically deleted in a couple of minutes, but you can also delete it manually, if you so
-desire.
+The setup message will be automatically deleted in a couple of minutes, but you can also delete it manually, if you so desire.
### Custom message
To create a custom message for your role menu like event role menu you saw above, you will need to send a message.
-Then get the ID of the message by following the steps in [how to get a message ID](#how-to-get-a-message-id-desktop) and
-type in the following command, `-rolemenu create (group name) -m (message id)`. You would then complete the role menu
-like you would any normal role menu.
+Then get the ID of the message by following the steps in [how to get a message ID](#how-to-get-a-message-id-desktop) and type in the following command, `-rolemenu create (group name) -m (message id)`.
+You would then complete the role menu like you would any normal role menu.
### Disabling DM confirmation
-If you do not want the bot to send you a DM when you are given or removed from a role, type in the following command
-`-rolemenu update (message id) -nodm`.
+If you do not want the bot to send you a DM when you are given or removed from a role, type in the following command `-rolemenu update (message id) -nodm`.
After you have finish editing or creating your role menu, it will display whether DM notifications are enabled or not.
-Note that YAGPDB does not allow you to disable error messages such as cool-down messages with the `nodm` switch or any
-other method.
+Note that YAGPDB does not allow you to disable error messages such as cool-down messages with the `nodm` switch or any other method.
### Remove roles on reaction remove
-Remove roles on reaction remove, this means instead of the old toggling mode, adding reactions will strictly give you
-the role, and removing reactions will only take away the role from you. This mode is on by default for new menus.
+Remove roles on reaction remove, this means instead of the old toggling mode, adding reactions will strictly give you the role, and removing reactions will only take away the role from you.
+This mode is on by default for new menus.
You can set old menus to use this switch using the command `rolemenu update (message id) -rr`.
@@ -198,34 +189,30 @@ You can set old menus to use this switch using the command `rolemenu update (mes
### Removing a role menu
-If you want to remove a role menu from a message, you can type in `-rolemenu remove (message id)` It will remove the
-role-menu from a message. The message itself won't be deleted but the bot will now not do anything with reactions on
-that message.
+If you want to remove a role menu from a message, you can type in `-rolemenu remove (message id)` It will remove the role-menu from a message.
+The message itself won't be deleted but the bot will now not do anything with reactions on that message.
### Editing a role menu
-If you want to change the emote for one your reaction, you can do so by typing in `-rolemenu edit (message id)` After
-you type it the command it will ask you to react on the emote you want to change. You will need to go to the role menu
-and react on the emote you want to change. After you have reacted on the desired emote, it will ask you to react with
-your new emote on the role menu.
+If you want to change the emote for one your reaction, you can do so by typing in `-rolemenu edit (message id)` After you type it the command it will ask you to react on the emote you want to change.
+You will need to go to the role menu and react on the emote you want to change.
+After you have reacted on the desired emote, it will ask you to react with your new emote on the role menu.
### Resetting all reactions
-If you edit your reaction emotes or simply want to give your emote a new clean slate. You can reset all the reactions
-by typing in `-rolemenu resetreactions (message id)`. It will remove all reactions on this menu and re-adds them, can
-be used to fix the order.
+If you edit your reaction emotes or simply want to give your emote a new clean slate.
+You can reset all the reactions by typing in `-rolemenu resetreactions (message id)`.
+It will remove all reactions on this menu and re-adds them, can be used to fix the order.
### Updating a role menu
-If you added a new role to your role group, you can update your role menu. Update it by typing in
-`-rolemenu update (message id)` and follow the instructions given.
+If you added a new role to your role group, you can update your role menu.
+Update it by typing in `-rolemenu update (message id)` and follow the instructions given.
## How to get a message ID (Desktop)
-Make sure you have enabled [developer mode](https://support.discordapp.com/hc/en-us/articles/206346498) in your Discord
-settings.
+Make sure you have enabled [developer mode](https://support.discordapp.com/hc/en-us/articles/206346498) in your Discord settings.
-To get the ID of the message you want to set the custom role menu on, click on the three dots on the far right hand side
-of the message and click on `Copy Message ID`.
+To get the ID of the message you want to set the custom role menu on, click on the three dots on the far right hand side of the message and click on `Copy Message ID`.
diff --git a/content/docs/tools-and-utilities/tickets.md b/content/docs/tools-and-utilities/tickets.md
index 50cc3df2..292bd7cb 100644
--- a/content/docs/tools-and-utilities/tickets.md
+++ b/content/docs/tools-and-utilities/tickets.md
@@ -4,14 +4,12 @@ weight = 730
description = "No ticket no entry"
+++
-Tickets let your members interact with your server staff in a private and more organized way. The bot will create a
-dedicated channel that can only be seen by the staff and the member who created the ticket, with the option to add more
-users as-needed.
+Tickets let your members interact with your server staff in a private and more organized way.
+The bot will create a dedicated channel that can only be seen by the staff and the member who created the ticket, with the option to add more users as-needed.
{{< callout context="note" title="Note: Required Bot Permissions" icon="outline/info-circle" >}}
-Make sure that the bot has permission to manage channels in the category you want the bot to create tickets in, as well
-as permission to send messages in said category, the transcript channels, and the ticket log channel.
+Make sure that the bot has permission to manage channels in the category you want the bot to create tickets in, as well as permission to send messages in said category, the transcript channels, and the ticket log channel.
{{< /callout >}}
@@ -19,48 +17,42 @@ as permission to send messages in said category, the transcript channels, and th
## Commands
-See the [Commands](/docs/core/all-commands/#tickets-) page for a listing of all commands. By default, we impose no
-restrictions on who can run these commands, though it may be pertinent to restrict sensitive commands such as the
-`-tickets close` command to staff members using [Command overrides](/docs/core/command-settings).
+See the [Commands](/docs/core/all-commands/#tickets-) page for a listing of all commands.
+By default, we impose no restrictions on who can run these commands, though it may be pertinent to restrict sensitive commands such as the `-tickets close` command to staff members using [Command overrides](/docs/core/command-settings).
## Configuration
At the top of the tickets settings page, you will find a toggle to enable or disable the ticket system in its entirety.
If you wish to disable certain parts, such as the `tickets adduser` command, please use a command override instead.
-If you disable the ticket system, the bot will respond with an error message when you try to run ticket-related
-commands, unless they are also disabled using command overrides.
+If you disable the ticket system, the bot will respond with an error message when you try to run ticket-related commands, unless they are also disabled using command overrides.
### Admin Roles
-Individual tickets can be set to an admin-only mode, where only users with these specified roles will be able to view
-that ticket channel.
+Individual tickets can be set to an admin-only mode, where only users with these specified roles will be able to view that ticket channel.
-Toggling this mode is done by running `-tickets adminonly` in the ticket's channel. Running the command again will
-deactivate the admin-only mode. This may serve useful when handling issues that require a higher level of privacy,
-such as complaints about staff members.
+Toggling this mode is done by running `-tickets adminonly` in the ticket's channel.
+Running the command again will deactivate the admin-only mode.
+This may serve useful when handling issues that require a higher level of privacy, such as complaints about staff members.
-Select as many roles as you like---they need not have "Administrator" or similar Discord permissions commonly associated
-with the term "admin".
+Select as many roles as you like---they need not have "Administrator" or similar Discord permissions commonly associated with the term "admin".
### Mod Roles
-These roles will be excluded from viewing tickets that are set to admin-only mode. Select as many as you like---they
-need not have "Manage Messages", "Moderate Members" or other Discord permissions commonly associated with the term
-"moderator".
+These roles will be excluded from viewing tickets that are set to admin-only mode.
+Select as many as you like---they need not have "Manage Messages", "Moderate Members" or other Discord permissions commonly associated with the term "moderator".
-Having selected separate roles for moderators and administrators can be useful in larger servers where the two roles
-have different responsibilities, but nothing prevents you from selecting the same role for both.
+Having selected separate roles for moderators and administrators can be useful in larger servers where the two roles have different responsibilities, but nothing prevents you from selecting the same role for both.
### Ticket Category
-The bot uses channels for tickets, and these channels are created in a category of your choosing. This category should
-be set up with the necessary permissions for the bot to create channels in it.
+The bot uses channels for tickets, and these channels are created in a category of your choosing.
+This category should be set up with the necessary permissions for the bot to create channels in it.
{{< callout context="note" title="Note: Discord Channel Limit" icon="outline/info-circle" >}}
-Discord limits categories to contain at most 50 channels. If you experience a high volume of tickets, consider closing
-some or researching alternative bots that handle tickets differently.
+Discord limits categories to contain at most 50 channels.
+If you experience a high volume of tickets, consider closing some or researching alternative bots that handle tickets differently.
{{< /callout >}}
@@ -69,12 +61,9 @@ some or researching alternative bots that handle tickets differently.
This is the channel where text transcripts of tickets will be sent to, given that you activated the option to do so.
This channel does not have to be part of the ticket category you selected further up.
-We also provide a separate option to download attachments sent in the ticket, which will be posted as a ZIP archive in
-this channel.
+We also provide a separate option to download attachments sent in the ticket, which will be posted as a ZIP archive in this channel.
-To keep admin-only tickets private, you can select a separate transcripts channel for tickets that were closed when they
-are in the admin-only mode during closure---if this is not necessary for your server, select the same channel as for the
-regular tickets.
+To keep admin-only tickets private, you can select a separate transcripts channel for tickets that were closed when they are in the admin-only mode during closure---if this is not necessary for your server, select the same channel as for the regular tickets.
### Ticket Status Updates
@@ -83,8 +72,8 @@ Selecting "None" will cause the bot to not send these updates.
### Opening Message
-This field supports [custom command templating](/docs/reference/templates/syntax-and-data) and will be executed in the
-newly created channel whenever a new ticket is created. Feel free to customize this as you see fit.
+This field supports [custom command templating](/docs/reference/templates/syntax-and-data) and will be executed in the newly created channel whenever a new ticket is created.
+Feel free to customize this as you see fit.
The default message is the following custom command code:
diff --git a/content/docs/welcome/getting-started.md b/content/docs/welcome/getting-started.md
index f99c4664..817c4147 100644
--- a/content/docs/welcome/getting-started.md
+++ b/content/docs/welcome/getting-started.md
@@ -21,9 +21,9 @@ You need to have the **Manage Server** permission to add the bot to your server.
### First Steps
-Before doing anything, you should first take a closer look at the Control Panel you just opened. It is the main
-interface for configuring the bot, and is where you will spend most of your time. Visit a few subpages to get a feel for
-the navigation and layout.
+Before doing anything, you should first take a closer look at the Control Panel you just opened.
+It is the main interface for configuring the bot, and is where you will spend most of your time.
+Visit a few subpages to get a feel for the navigation and layout.
@@ -32,10 +32,11 @@ the navigation and layout.
-Afterward, visit the Commands tab (Core > Command settings) and make sure that the default prefix (`-`) does not
-conflict with other bots you may have. Also make sure to enable all commands, such that you can actually use YAGPDB.
+Afterward, visit the Commands tab (Core > Command settings) and make sure that the default prefix (`-`) does not conflict with other bots you may have.
+Also make sure to enable all commands, such that you can actually use YAGPDB.
-Try some commands! Something like `catfact` or `dadjoke`, to get the party going.
+Try some commands!
+Something like `catfact` or `dadjoke`, to get the party going.
If those did not work, please read the FAQ on the support server.
## About this Documentation
@@ -43,5 +44,4 @@ If those did not work, please read the FAQ on the support server.
This documentation aims to go through all of YAGPDB's features as they appear in the order on the control panel.
Reference material, or miscellaneous topics are in their own category as to not bloat things up with unnecessary detail.
-We recommend reading this document in its entirety, from start to finish, exempting reference material, before or during
-setup.
+We recommend reading this document in its entirety, from start to finish, exempting reference material, before or during setup.
diff --git a/content/docs/welcome/introduction.md b/content/docs/welcome/introduction.md
index 38f40a38..7fbca821 100644
--- a/content/docs/welcome/introduction.md
+++ b/content/docs/welcome/introduction.md
@@ -6,28 +6,25 @@ description = "Start here!"
> Documentation is for users. - Rob Pike
-This is the documentation for [YAGPDB](https://yagpdb.xyz); this document in its current form is a work in progress, as
-it is an attempt to move away from the current documentation hosted via GitBook.
+This is the documentation for [YAGPDB](https://yagpdb.xyz); this document in its current form is a work in progress, as it is an attempt to move away from the current documentation hosted via GitBook.
-This page is built with [Hugo](https://gohugo.io/) in conjunction with the [Doks theme](https://getdoks.org) as an
-experiment to see if it is a viable alternative.
+This page is built with [Hugo](https://gohugo.io/) in conjunction with the [Doks theme](https://getdoks.org) as an experiment to see if it is a viable alternative.
## Other Resources
### Support Server
-If you need help with YAGPDB, please join the [support server](https://discord.gg/4udtcA5) and ask in the appropriate
-channel. Any other online forum is not official and should be generally treated as inaccurate.
+If you need help with YAGPDB, please join the [support server](https://discord.gg/4udtcA5) and ask in the appropriate channel.
+Any other online forum is not official and should be generally treated as inaccurate.
Questions regarding the clarity of this documentation are also welcome, as they help us improve the documentation.
-Remember to first read `#information` and `#faq` before asking questions. Our support staff are volunteers, so please be
-patient when they don't respond in 10-3 seconds, they are probably busy with something else.
+Remember to first read `#information` and `#faq` before asking questions.
+Our support staff are volunteers, so please be patient when they don't respond in 10-3 seconds, they are probably busy with something else.
### Learning Center
-If you are new to YAGPDB's custom command system, you might want to check out the
-[Learning Center](/learn/welcome/introduction) for a more structured approach to learning how to write custom commands.
+If you are new to YAGPDB's custom command system, you might want to check out the [Learning Center](/learn/welcome/introduction) for a more structured approach to learning how to write custom commands.
However, it is not a replacement for the documentation, so you will need to read both to actually write custom commands.
@@ -40,8 +37,8 @@ Please note that premium functionality is just a bonus for supporting the projec
### Helping Out
-Please do not shy away from helping other users in the [support server](https://discord.gg/4udtcA5) if you believe you
-can help them. This is a great way to give back to the community and help the project grow.
+Please do not shy away from helping other users in the [support server](https://discord.gg/4udtcA5) if you believe you can help them.
+This is a great way to give back to the community and help the project grow.
### Contributing
@@ -49,15 +46,12 @@ can help them. This is a great way to give back to the community and help the pr
#### Improving the Bot
-Additionally, you can contribute to YAGPDB itself by submitting pull requests to its
-[GitHub repository](https://github.com/botlabs-gg/yagpdb) if you are feeling comfortable with [Go](https://golang.org/).
+Additionally, you can contribute to YAGPDB itself by submitting pull requests to its [GitHub repository](https://github.com/botlabs-gg/yagpdb) if you are feeling comfortable with [Go](https://golang.org/).
-Please take a closer look at the [contributing guidelines](https://github.com/botlabs-gg/yagpdb/blob/master/CONTRIBUTING.md)
-to increase the chances of your pull request being accepted; a good starting point is also to implement highly-upvoted
-suggestions in the `#suggestions` channel on the support server.
+Please take a closer look at the [contributing guidelines](https://github.com/botlabs-gg/yagpdb/blob/master/CONTRIBUTING.md) to increase the chances of your pull request being accepted.
+A good starting point is also to implement highly-upvoted suggestions in the `#suggestions` channel on the support server.
#### Writing Documentation
-If you feel that contributing to the bot itself is a bit too daunting, you are just as welcome to write and improve this
-documentation. All you really need is a decent (text) editor of your choice and a good look at our [docs contributing
-guidelines](https://github.com/botlabs-gg/yagpdb-docs-v2/blob/master/.github/CONTRIBUTING.md).
+If you feel that contributing to the bot itself is a bit too daunting, you are just as welcome to write and improve this documentation.
+All you really need is a decent (text) editor of your choice and a good look at our [docs contributing guidelines](https://github.com/botlabs-gg/yagpdb-docs-v2/blob/master/.github/CONTRIBUTING.md).
diff --git a/content/docs/welcome/premium.md b/content/docs/welcome/premium.md
index c027aa90..12f7a536 100644
--- a/content/docs/welcome/premium.md
+++ b/content/docs/welcome/premium.md
@@ -4,9 +4,8 @@ weight = 130
description = "Unlock additional features and functionality by supporting YAGPDB."
+++
-YAGPDB provides added functionality to servers which are assigned a premium slot by a user. On the official instance of
-YAGPDB, these premium slots can be acquired as a perk of being a [Patron](https://www.patreon.com/yagpdb) to Botlabs'
-YAGPDB.
+YAGPDB provides added functionality to servers which are assigned a premium slot by a user.
+On the official instance of YAGPDB, these premium slots can be acquired as a perk of being a [Patron](https://www.patreon.com/yagpdb) to Botlabs' YAGPDB.
## Benefits
@@ -83,8 +82,7 @@ A premium server unlocks the following benefits:
{{< callout context="danger" title="Danger: Disabled Features" icon="outline/alert-octagon" >}}
-Some features enhanced or enabled by premium have been disabled on Botlabs' publicly hosted instance, often due to
-ratelimits with 3rd party APIs YAGPDB relies on.
+Some features enhanced or enabled by premium have been disabled on Botlabs' publicly hosted instance, often due to ratelimits with 3rd party APIs YAGPDB relies on.
Any features marked as **DISABLED ON OFFICIAL INSTANCE** will **not** be available if you become a Patron to Botlabs.
@@ -94,13 +92,13 @@ Any features marked as **DISABLED ON OFFICIAL INSTANCE** will **not** be availab
### Getting a Premium Slot
-To enable premium on your server, you'll first need to get a premium slot assigned to your account. This is tied to your
-Discord user ID and cannot be transferred.
+To enable premium on your server, you'll first need to get a premium slot assigned to your account.
+This is tied to your Discord user ID and cannot be transferred.
#### Patreon
-We have a [Patreon campaign](https://www.patreon.com/yagpdb) where you can pledge to support YAGPDB and get premium
-slots in return. This is the only way to purchase more than one premium slot.
+We have a [Patreon campaign](https://www.patreon.com/yagpdb) where you can pledge to support YAGPDB and get premium slots in return.
+This is the only way to purchase more than one premium slot.
1. Pledge the required minimum amount to unlock a premium slot.
2. [Link your Patreon account][p-link] to your Discord account.
@@ -112,8 +110,7 @@ slots in return. This is the only way to purchase more than one premium slot.
#### Discord Store
If you prefer not to use Patreon, you can purchase **a single premium slot** directly from [our Discord Store][d-store].
-Simply click on "Subscribe" and follow the on-screen instructions to complete your purchase---it may take up to 30
-minutes until the slot is available for assignment to a server on the [premium page](https://yagpdb.xyz/premium).
+Simply click on "Subscribe" and follow the on-screen instructions to complete your purchase---it may take up to 30 minutes until the slot is available for assignment to a server on the [premium page](https://yagpdb.xyz/premium).
If you wish to purchase multiple slots, you will need to go through Patreon as explained above.
@@ -121,8 +118,7 @@ If you wish to purchase multiple slots, you will need to go through Patreon as e
#### From a Code
-A bot owner may generate temporary or permanent premium codes for giveaways, perks, or to manually reward donors who
-donate through other sources/when the Patreon API is down.
+A bot owner may generate temporary or permanent premium codes for giveaways, perks, or to manually reward donors who donate through other sources/when the Patreon API is down.
1. Visit [/premium](https://yagpdb.xyz/premium).
2. Paste your code into the "Redeem Code" field, and click "Redeem Code." You may also use the "Check Code" button to
@@ -130,8 +126,8 @@ donate through other sources/when the Patreon API is down.
### Assigning a Slot
-Once you have obtained a Premium slot, it should appear on the [/premium](https://yagpdb.xyz/premium) page and be
-available to be assigned to a server. For each slot, choose a server to assign it to, then click "Update Premium Slot."
+Once you have obtained a Premium slot, it should appear on the [/premium](https://yagpdb.xyz/premium) page and be available to be assigned to a server.
+For each slot, choose a server to assign it to, then click "Update Premium Slot."
You can assign your premium slots to any server with YAGPDB in it and no existing slot assigned.
@@ -158,11 +154,12 @@ When hosting YAGPDB yourself, you have access to a few methods to source premium
### Changing Limits
-Functionally raising or lowering limits, both for premium and non-premium servers, is accomplished by altering the
-source code. Most limits are numerical values that only need to be updated in one location. For most of the above listed
-numerical limits, the relevant key or constant is named in parenthesis. Ex. (`MaxMessageTriggersPremium`). It is
-recommended you familiarize yourself with the codebase before making changes. Find where these keys or constants are
-defined and alter their values as you wish.
+Functionally raising or lowering limits, both for premium and non-premium servers, is accomplished by altering the source code.
+Most limits are numerical values that only need to be updated in one location.
+For most of the above listed numerical limits, the relevant key or constant is named in parenthesis.
+Ex. (`MaxMessageTriggersPremium`).
+It is recommended you familiarize yourself with the codebase before making changes.
+Find where these keys or constants are defined and alter their values as you wish.
diff --git a/content/learn/advanced/custom-interactions/creating-interactive-elements.md b/content/learn/advanced/custom-interactions/creating-interactive-elements.md
index 2024647a..f869f283 100644
--- a/content/learn/advanced/custom-interactions/creating-interactive-elements.md
+++ b/content/learn/advanced/custom-interactions/creating-interactive-elements.md
@@ -3,18 +3,17 @@ title = "Creating Interactive Elements"
weight = 412
+++
-Before you can start triggering custom commands with interactive elements---such as buttons---you'll obviously need
-to have elements to interact with. In this section, we'll cover how to create these elements and explore their
-differences.
+Before you can start triggering custom commands with interactive elements---such as buttons---you'll obviously need to have elements to interact with.
+In this section, we'll cover how to create these elements and explore their differences.
## Message Components
### Buttons
-Buttons are probably the simplest interactive element to create, so we'll start with them. To create a button, we use
-the [`cbutton`](docs/reference/templates/functions#cbutton) function. In and of itself, that is rather useless, so we'll
-also have to attach it to a message. We do that by calling the
-[`complexMessage`](docs/reference/templates/functions#complexmessage) builder and adding the result of `cbutton` to it.
+Buttons are probably the simplest interactive element to create, so we'll start with them.
+To create a button, we use the [`cbutton`](docs/reference/templates/functions#cbutton) function.
+In and of itself, that is rather useless, so we'll also have to attach it to a message.
+We do that by calling the [`complexMessage`](docs/reference/templates/functions#complexmessage) builder and adding the result of `cbutton` to it.
Finally, we send the message.
```yag
@@ -27,30 +26,33 @@ Result:
-We've successfully crated a basic button! It doesn't do anything yet, but we'll cover that in a later section.
-In the meantime, play around with the values `cbutton` takes. Try to attach an emoji to it, or change its style!
+We've successfully crated a basic button!
+It doesn't do anything yet, but we'll cover that in a later section.
+In the meantime, play around with the values `cbutton` takes.
+Try to attach an emoji to it, or change its style!
### Select Menus
-Select menus act as dropdowns, allowing users to select one or more of several options. To further complicate things,
-select menus come in different types, each offering different functionality. We'll first focus on the most intuitive
-type, the **Text** select menu. This type allows you to define a custom list of options.
+Select menus act as dropdowns, allowing users to select one or more of several options.
+To further complicate things, select menus come in different types, each offering different functionality.
+We'll first focus on the most intuitive type, the **Text** select menu.
+This type allows you to define a custom list of options.
Available select menu types are as follows:
-- **Text** - The options available to be selected are defined when creating the select menu. Options have labels, and
- can optionally have emojis and longer-form descriptions.
+- **Text** - The options available to be selected are defined when creating the select menu.
+ Options have labels, and can optionally have emojis and longer-form descriptions.
- **User** - The options are populated with users on the server by Discord.
- **Role** - The options are populated with roles on the server by Discord.
- **Mentionable** - The options are auto-populated with both users and roles on the server by Discord, allowing members
to select both.
-- **Channel** - The options are populated with channels on the server by Discord. You can limit which channel types
- appear as options when creating the select menu.
+- **Channel** - The options are populated with channels on the server by Discord.
+ You can limit which channel types appear as options when creating the select menu.
#### Text Select Menus
-To create a text select menu, we use the [`cmenu`](docs/reference/templates/functions#cmenu) function. Then, just like
-with a button, we attach it to a message and send it.
+To create a text select menu, we use the [`cmenu`](docs/reference/templates/functions#cmenu) function.
+Then, just like with a button, we attach it to a message and send it.
```yag
{{ $menu := cmenu
@@ -71,17 +73,16 @@ Opening the select menu that was sent using the above code should yield the foll
-In this menu, our first option (Ducks) is defined as `default`, which is why it is already selected when we look at the
-menu on our server. You can define multiple default options, however the amount of default options you define must fall
-between your `min_values` and `max_values`.
+In this menu, our first option (Ducks) is defined as `default`, which is why it is already selected when we look at the menu on our server.
+You can define multiple default options, however the amount of default options you define must fall between your `min_values` and `max_values`.
-We have also set the `max_values` to 3, and we haven't set a `min_values` argument. This means the server member could
-select anywhere between 1 and 3 of these options.
+We have also set the `max_values` to 3, and we haven't set a `min_values` argument.
+This means the server member could select anywhere between 1 and 3 of these options.
#### Other Select Menu Types
-The other select menu types are created in the same way as the text select menu, but with a few differences. As Discord
-automatically populates the options, you need not---nor can you---define these options.
+The other select menu types are created in the same way as the text select menu, but with a few differences.
+As Discord automatically populates the options, you need not---nor can you---define these options.
```yag
{{ $menu := cmenu
@@ -98,8 +99,8 @@ automatically populates the options, you need not---nor can you---define these o
##### Channel Select Menus
-Channel select menus are a bit different from the other types, as they allow you to specify which channel types you
-want to include in the menu. You do this by using the `channel_types` field, which accepts a slice of [channel types].
+Channel select menus are a bit different from the other types, as they allow you to specify which channel types you want to include in the menu.
+You do this by using the `channel_types` field, which accepts a slice of [channel types].
[channel types]: https://discord.com/developers/docs/resources/channel#channel-object-channel-types
@@ -127,14 +128,14 @@ This gives us a select menu that allows us to select only guild announcement and
## Modals
-Modals are a pop-up form that YAGPDB can send in response to an interaction. It allows users to privately input text
-which is sent directly to YAGPDB for use in your custom command. Although modals are not interactive elements in the
-same way buttons and menus are, we will cover them here for completeness' sake.
+Modals are a pop-up form that YAGPDB can send in response to an interaction.
+It allows users to privately input text which is sent directly to YAGPDB for use in your custom command.
+Although modals are not interactive elements in the same way buttons and menus are, we will cover them here for completeness' sake.
-Modals are created using the [`cmodal`](docs/reference/templates/functions#cmodal) function. The modal is then sent
-with the [`sendModal`](docs/reference/templates/functions#sendmodal) function. Sending a modal is strictly a response,
-meaning it can only be sent once a user clicks a button or uses a select menu. You cannot send a modal as a response to
-a user submitting a modal.
+Modals are created using the [`cmodal`](docs/reference/templates/functions#cmodal) function.
+The modal is then sent with the [`sendModal`](docs/reference/templates/functions#sendmodal) function.
+Sending a modal is strictly a response, meaning it can only be sent once a user clicks a button or uses a select menu.
+You cannot send a modal as a response to a user submitting a modal.
### Modal Structure
@@ -157,17 +158,16 @@ Let's consider the following piece of code:
{{ sendModal $modal }}
```
-This code will send a modal with three fields. The first field is a required text input, with "Duck" as a placeholder,
-the second field is a text input with a default value, and the third field is a long-form text input that requires at
-least 100 characters. The custom ID is set to `modals-my_first_modal`, which helps us identifying the modal when we use
-a modal submission trigger for a custom command.
+This code will send a modal with three fields.
+The first field is a required text input, with "Duck" as a placeholder, the second field is a text input with a default value, and the third field is a long-form text input that requires at least 100 characters.
+The custom ID is set to `modals-my_first_modal`, which helps us identifying the modal when we use a modal submission trigger for a custom command.
## Multiple Components
-You learned how to create messages with just one component attached to it, but the whole point of components is to have
-*a lot* of them available. Let's start with adding some more buttons!
+You learned how to create messages with just one component attached to it, but the whole point of components is to have *a lot* of them available.
+Let's start with adding some more buttons!
### More Buttons
@@ -191,12 +191,12 @@ To add more buttons to a single row, simply toss them all into a slice, like so.
-At this stage we have three buttons. Both of the first two buttons will trigger our duck trigger custom command, but the
-third button will not trigger any custom command. Link buttons do not create _interactions_.
+At this stage we have three buttons.
+Both of the first two buttons will trigger our duck trigger custom command, but the third button will not trigger any custom command.
+Link buttons do not create _interactions_.
-We can differentiate between the two buttons using `.StrippedID`, which, just like `.StrippedMsg`, returns our Custom ID
-without the trigger and everything else before that. In our example, `.StrippedID` will return `-alpha` for the first
-button and `-beta` for the second button.
+We can differentiate between the two buttons using `.StrippedID`, which, just like `.StrippedMsg`, returns our Custom ID without the trigger and everything else before that.
+In our example, `.StrippedID` will return `-alpha` for the first button and `-beta` for the second button.
Confirming this behavior will be left as an exercise to the reader (you).
@@ -204,8 +204,8 @@ Let's add a select menu as well, now.
### Buttons and a Select Menu
-We start by copying the previous code over, and define our menu using `cmenu`. Then, it's just simply adding our newly
-created menu to the `"menu"` key of the complex message builder, and sending said message.
+We start by copying the previous code over, and define our menu using `cmenu`.
+Then, it's just simply adding our newly created menu to the `"menu"` key of the complex message builder, and sending said message.
```yag
{{ $button1 := cbutton "label" "Duck One" "custom_id" "buttons-duck-alpha" "style" "success" }}
@@ -230,10 +230,9 @@ created menu to the `"menu"` key of the complex message builder, and sending sai
### Ordering Components
-Let's say we want to play Tic-Tac-Toe. If we just add nine buttons into the same slice in our complex message builder,
-they will just fill the first row with five buttons, and the second row with four buttons, which is definitely not what
-we are looking for. The solution is to tell YAGPDB precisely how the rows look like and then pass each row to the
-`"button"` or `"menu"` key.
+Let's say we want to play Tic-Tac-Toe.
+If we just add nine buttons into the same slice in our complex message builder, they will just fill the first row with five buttons, and the second row with four buttons, which is definitely not what we are looking for.
+The solution is to tell YAGPDB precisely how the rows look like and then pass each row to the `"button"` or `"menu"` key.
```yag
{{ $blankEmoji := sdict "name" "⬜" }}
@@ -250,10 +249,9 @@ we are looking for. The solution is to tell YAGPDB precisely how the rows look l
#### Action Rows
-As you continue to attach more components, YAGPDB will automatically overflow into new rows. However, this may be
-undesirable in some cases, such as when you want to have a specific layout for your buttons and/or menus. For that
-purpose, `complexMessage` accepts another key, `"components"`, which is essentially just you providing all the action
-rows you want.
+As you continue to attach more components, YAGPDB will automatically overflow into new rows.
+However, this may be undesirable in some cases, such as when you want to have a specific layout for your buttons and/or menus.
+For that purpose, `complexMessage` accepts another key, `"components"`, which is essentially just you providing all the action rows you want.
To illustrate, we'll create a message with five action rows, each with a different number of buttons or menus in it.
@@ -276,10 +274,8 @@ To illustrate, we'll create a message with five action rows, each with a differe
### Using emojis
-Buttons and Select Menu Options both have an `"emoji"` field, but this field does not accept the regular unicode/name:id
-formula like reactions do. Emojis in components follow the [partial emoji
-object](https://discord.com/developers/docs/resources/emoji#emoji-object) structure, however only the ID *or* the Name
-fields are required, depending on if you are using a custom emoji or not.
+Buttons and Select Menu Options both have an `"emoji"` field, but this field does not accept the regular unicode/name:id formula like reactions do.
+Emojis in components follow the [partial emoji object](https://discord.com/developers/docs/resources/emoji#emoji-object) structure, however only the ID *or* the Name fields are required, depending on if you are using a custom emoji or not.
| Field | Description |
| ----- | ----------------------------------------------------------------------------------------------------- |
@@ -297,7 +293,5 @@ fields are required, depending on if you are using a custom emoji or not.
### Using dictionaries instead
-As you probably already discovered when building embeds, you can use `sdict` in favor of `cembed` to create some sort of
-skeleton of your embed for later adjustments, with YAGPDB's template engine automagically handling the conversion for
-you. This is also true for all the elements we covered in this section, which makes it far easier to conditionally
-change certain aspects of your interactive elements.
+As you probably already discovered when building embeds, you can use `sdict` in favor of `cembed` to create some sort of skeleton of your embed for later adjustments, with YAGPDB's template engine automagically handling the conversion for you.
+This is also true for all the elements we covered in this section, which makes it far easier to conditionally change certain aspects of your interactive elements.
diff --git a/content/learn/advanced/custom-interactions/introduction.md b/content/learn/advanced/custom-interactions/introduction.md
index 5fc30986..2a890f48 100644
--- a/content/learn/advanced/custom-interactions/introduction.md
+++ b/content/learn/advanced/custom-interactions/introduction.md
@@ -6,16 +6,13 @@ description = "Learn how to use buttons, modals, and select menus in custom comm
{{< callout context="danger" title="Danger: Advanced Topic" icon="outline/alert-octagon" >}}
-Use of interactions within YAGPDB is an advanced topic; you will need a thorough understanding of YAGPDB's scripting
-language before learning interactions.
+Use of interactions within YAGPDB is an advanced topic; you will need a thorough understanding of YAGPDB's scripting language before learning interactions.
{{< /callout >}}
-Interactions within Discord allow server members to use alternative, built-in features to trigger bots to take action
-other than messages or reactions. These features include built-in buttons, dropdown selection menus, or submitting a
-modal (basically a pop-up form). Within custom commands it is possible to not only create and customize these new
-interactive features, but respond to them as well, opening up new possibilities for ephemeral message responses, modals,
-and more within custom commands.
+Interactions within Discord allow server members to use alternative, built-in features to trigger bots to take action other than messages or reactions.
+These features include built-in buttons, dropdown selection menus, or submitting a modal (basically a pop-up form).
+Within custom commands it is possible to not only create and customize these new interactive features, but respond to them as well, opening up new possibilities for ephemeral message responses, modals, and more for your server.
## Interaction Lifetime
@@ -23,9 +20,8 @@ An interaction's lifetime starts with the initial *interaction* with an *interac
1. A server member clicks on a *button*, uses a *menu*, or submits a *modal* after filling it out.
2. This interaction is sent to YAGPDB, and becomes available to trigger any custom commands which match it.
-3. Within the triggered custom command(s), YAGPDB should then *respond* once to the interaction, sending a message,
- updating the triggering message, or sending a modal. This may only be done within the CC which was triggered by the
- interaction.
+3. Within the triggered custom command(s), YAGPDB should then *respond* once to the interaction, sending a message, updating the triggering message, or sending a modal.
+ This may only be done within the CC which was triggered by the interaction.
4. (optional) Continue to send followup responses for up to 15 minutes until the interaction token expires.
```mermaid
@@ -43,25 +39,20 @@ H -.-> F
## Definitions
-On the following pages, we will use the listed terms with their respective definitions, which are also used as such by
-the Discord API.
+On the following pages, we will use the listed terms with their respective definitions, which are also used as such by the Discord API.
Interaction
-: A user engaging with YAGPDB through one of Discord's built-in features: Clicking a button, Making a
-selection with a select menu, or Submitting a modal.
+: A user engaging with YAGPDB through one of Discord's built-in features: Clicking a button, Making a selection with a select menu, or Submitting a modal.
Response
-: YAGPDB is required to respond promptly -- that is, within three (3) seconds -- after receiving an interaction by
-either sending a message or modal, or by updating the message on which the interaction was triggered. If it does not do
-this, the user triggering the interaction will see a "This application did not respond" error. The bot cannot respond to
-an interaction more than once.
+: YAGPDB is required to respond promptly---that is, within three (3) seconds---after receiving an interaction by either sending a message or modal, or by updating the message on which the interaction was triggered.
+If it does not do this, the user triggering the interaction will see a "This application did not respond" error.
+The bot cannot respond to an interaction more than once.
Followup
-: Since YAGPDB may only *respond* to an *interaction* once, it is subsequently required to send an interaction
-followup if it still needs to interface with the interaction. These followups can be sent up to 15 minutes after the
-initial interaction, and you can send as many as you want. YAGPDB may only send a followup in one of the following ways:
-Sending a followup message, editing an initial response or previous followup message, or getting an initial response or
-previous followup message.
+: Since YAGPDB may only *respond* to an *interaction* once, it is subsequently required to send an interaction followup if it still needs to interface with the interaction.
+These followups can be sent up to 15 minutes after the initial interaction, and you can send as many as you want.
+YAGPDB may only send a followup in one of the following ways: Sending a followup message, editing an initial response or previous followup message, or getting an initial response or previous followup message.
Interactive Elements
: Elements users can interact with to send *interactions*, i.e. buttons, menus, and modals.
@@ -70,23 +61,21 @@ Message Components
: *Interactive Elements* which can be attached to YAGPDB's Discord messages, i.e. buttons and menus.
Button
-: A button appearing in or under a Discord message sent by YAGPDB. You can create and customize these
-buttons' appearance and behavior with color, emoji, label text, etc. When a button is clicked, an *interaction* is sent
-to the bot.
+: A button appearing in or under a Discord message sent by YAGPDB.
+You can create and customize these buttons' appearance and behavior with color, emoji, label text, etc. When a button is clicked, an *interaction* is sent to the bot.
Menu
-: A dropdown select menu appearing in or under a Discord message sent by YAGPDB. You can create and customize these
-menus' appearance and behavior with placeholder text, predefined options with labels, descriptions, and/or emojis,
-designate the entire menu as a user or role select menu instead, etc. When a select menu is used, an *interaction* is
-sent to the bot.
+: A dropdown select menu appearing in or under a Discord message sent by YAGPDB.
+You can create and customize these menus' appearance and behavior with placeholder text, predefined options with labels, descriptions, and/or emojis, designate the entire menu as a user or role select menu instead.
+When a select menu is used, an *interaction* is sent to the bot.
Modal
-: A pop-up form YAGPDB can send in response to an interaction. It allows users to privately input text which
-is sent directly to YAGPDB for use in CC scripting. You can create and customize these modals' appearance and
-behavior with a title and fields. YAGPDB can both **receive a submitted modal** (which is an
-*interaction*), and **send a modal** for a member to fill out, (which is an interaction *response*).
+: A pop-up form YAGPDB can send in response to an interaction.
+It allows users to privately input text which is sent directly to YAGPDB for use in CC scripting.
+You can create and customize these modals' appearance and behavior with a title and fields.
+YAGPDB can both **receive a submitted modal** (which is an *interaction*), and **send a modal** for a member to fill out, (which is an interaction *response*).
Ephemeral
-: An ephemeral message is sent to a server channel but only appears to a single user. YAGPDB cannot send
-these ephemeral messages to users except in response to an *interaction*. Both *response* messages and *followup*
-messages can be ephemeral.
+: An ephemeral message is sent to a server channel but only appears to a single user.
+YAGPDB cannot send these ephemeral messages to users except in response to an *interaction*.
+Both *response* messages and *followup* messages can be ephemeral.
diff --git a/content/learn/advanced/custom-interactions/parsing-an-interaction.md b/content/learn/advanced/custom-interactions/parsing-an-interaction.md
index fc875dfe..d4e83fd9 100644
--- a/content/learn/advanced/custom-interactions/parsing-an-interaction.md
+++ b/content/learn/advanced/custom-interactions/parsing-an-interaction.md
@@ -3,16 +3,15 @@ title = "Parsing an Interaction"
weight = 412
+++
-Custom Commands with the [Message Component](/docs/custom-commands/commands#component) or [Modal
-Submission](/docs/custom-commands/commands#modal) trigger allow you to take action upon the press of a button, use of a
-select menu, or completion of a modal form. Interaction triggers provide new context data for templating.
+Custom Commands with the [Message Component](/docs/custom-commands/commands#component) or [Modal Submission](/docs/custom-commands/commands#modal) trigger allow you to take action upon the press of a button, use of a select menu, or completion of a modal form.
+Interaction triggers provide new context data for templating.
In this section, we'll cover the data available and how to make use of it.
## Important Context Data
-A short list of the more important context data available is provided below. For a full list, please see the
-[documentation on the interaction object](/docs/reference/templates/syntax-and-data#interaction).
+A short list of the more important context data available is provided below.
+For a full list, please see the [documentation on the interaction object](/docs/reference/templates/syntax-and-data#interaction).
| **Field** | **Description** |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -21,22 +20,20 @@ A short list of the more important context data available is provided below. For
| .StrippedID | "Strips" or cuts off the triggering part of the custom ID and prints out everything else after that. Bear in mind, when using regex as trigger, for example `"day"` and input custom ID is `"have-a-nice-day-my-dear-YAG"` output will be `"-my-dear-YAG"` --- rest is cut off. |
| .Values | Slice of all options selected with a select menu, OR all values input into a modal in order. |
-`.Interaction.Token` *must* be provided to any followup functions you decide to use later. If you are
-using these in subsequent script executions, it's a good idea to save this to database when the interaction occurs.
+`.Interaction.Token` *must* be provided to any followup functions you decide to use later.
+If you are using these in subsequent script executions, it's a good idea to save this to database when the interaction occurs.
-`.CustomID` can be used to identify which component or modal triggered the command. `.StrippedID` can be used to quickly
-parse out arguments in your custom ID, and use them in your response.
+`.CustomID` can be used to identify which component or modal triggered the command. `.StrippedID` can be used to quickly parse out arguments in your custom ID, and use them in your response.
-`.Values` is used to capture values a user selected in a select menu or submitted to a modal. When creating a select
-menu and defining the options, the `"value"` field for each option defines which values will show up in this slice if
-chosen. A modal's values are simply the values of each field in order.
+`.Values` is used to capture values a user selected in a select menu or submitted to a modal.
+When creating a select menu and defining the options, the `"value"` field for each option defines which values will show up in this slice if chosen.
+A modal's values are simply the values of each field in order.
## Parsing Buttons
-As buttons do not provide any `.Values` data, we have to rely on the custom ID to pass around any data that a button may
-carry. Let us consider a message with two buttons, one for joining a game of Uno, and the other one for leaving said
-game. We can set the custom IDs of these buttons to `uno-join` and `uno-leave`, respectively, and trigger our custom
-command on `uno-` as custom ID regex.
+As buttons do not provide any `.Values` data, we have to rely on the custom ID to pass around any data that a button may carry.
+Let us consider a message with two buttons, one for joining a game of Uno, and the other one for leaving said game.
+We can set the custom IDs of these buttons to `uno-join` and `uno-leave`, respectively, and trigger our custom command on `uno-` as custom ID regex.
```yag
{{ if eq .StrippedID "join" }}
@@ -48,21 +45,21 @@ command on `uno-` as custom ID regex.
{{< callout context="caution" title="Warning: Unique Custom ID" icon="outline/alert-triangle" >}}
-Multiple buttons and menus cannot have the same custom ID in one message. It is a good idea to have a common prefix and
-then encode the action the menu or button carries in the custom ID.
+Multiple buttons and menus cannot have the same custom ID in one message.
+It is a good idea to have a common prefix and then encode the action the menu or button carries in the custom ID.
{{< /callout >}}
## Parsing Select Menus
-Select menus provide us with a `.Values` slice, which we can use to parse the values selected by the user. This slice is
-ordered by the order in which the user selected the options, so if a user selects the first option, then the third
-option, then the second option, the `.Values` slice will be `["first", "third", "second"]`. Of course, when you set your
-menu to allow only one selection, this need not be a concern, as `.Values` will only ever contain one value.
+Select menus provide us with a `.Values` slice, which we can use to parse the values selected by the user.
+This slice is ordered by the order in which the user selected the options, so if a user selects the first option, then the third option, then the second option, the `.Values` slice will be `["first", "third", "second"]`.
+Of course, when you set your menu to allow only one selection, this need not be a concern, as `.Values` will only ever contain one value.
-Let us consider a select menu with several options for Uno cards, where the user can choose only one card. We will have
-to verify that the user selected a valid option, that is, same color or same number. To simplify, we do not consider
-wildcards here. Our code could look similar to the following listing.
+Let us consider a select menu with several options for Uno cards, where the user can choose only one card.
+We will have to verify that the user selected a valid option, that is, same color or same number.
+To simplify, we do not consider wildcards here.
+Our code could look similar to the following listing.
```yag
{{ $selectedOptions := .Values }} {{/* ["blue-7"] */}}
@@ -85,16 +82,14 @@ wildcards here. Our code could look similar to the following listing.
{{ end }}
```
-Having only one option users can choose certainly simplifies working with `.Values` under select menus, but most of the
-time it's probably not that easy. Here, we encourage you to fully consider what `.Values` gives you and what
-specifically you're interested in. If, for instance, you only want to find out whether a certain option was selected, we
-can use [`inFold`](/docs/reference/templates/functions/#infold). In some other cases, we simply may not care at all,
-just that we got a slice of things.
+Having only one option users can choose certainly simplifies working with `.Values` under select menus, but most of the time it's probably not that easy.
+Here, we encourage you to fully consider what `.Values` gives you and what specifically you're interested in.
+If, for instance, you only want to find out whether a certain option was selected, we can use [`inFold`](/docs/reference/templates/functions/#infold).
+In some other cases, we simply may not care at all, just that we got a slice of things.
## Parsing Modals
-Thankfully, YAGPDB handles the grunt work of parsing a modal for you, and populates `.Values` according to the order of
-the fields in your modal.
+Thankfully, YAGPDB handles the grunt work of parsing a modal for you, and populates `.Values` according to the order of the fields in your modal.
Consider the following modal being submitted:
diff --git a/content/learn/advanced/custom-interactions/responding-to-an-interaction.md b/content/learn/advanced/custom-interactions/responding-to-an-interaction.md
index 433cddb6..ef605b8f 100644
--- a/content/learn/advanced/custom-interactions/responding-to-an-interaction.md
+++ b/content/learn/advanced/custom-interactions/responding-to-an-interaction.md
@@ -3,54 +3,50 @@ title ="Responding to an Interaction"
weight = 413
+++
+While technically not required, responding to an interaction with one of Discord's allotted initial responses is crucial if you don't want your users to see an error after interacting, greatly improving user experience.
+An interaction may be responded to only once.
-While technically not required, responding to an interaction with one of Discord's allotted initial responses is crucial
-if you don't want your users to see an error after interacting, greatly improving user experience. An interaction may be
-responded to only once.
-
-You can only respond to an interaction within the custom command triggered by said interaction, with the exception that
-a CC executed with `execCC` by the triggered CC will be able to send initial responses to the triggering interaction as
-well.
+You can only respond to an interaction within the custom command triggered by said interaction, with the exception that a CC executed with `execCC` by the triggered CC will be able to send initial responses to the triggering interaction as well.
## Initial Response
-An initial response is the first response sent to an interaction. This response **must** be sent within 3 seconds of the
-interaction being received, or the user will see a "This application did not respond" error.
+An initial response is the first response sent to an interaction.
+This response **must** be sent within 3 seconds of the interaction being received, or the user will see a "This application did not respond" error.
Possible initial responses:
-- Output text in your script response field. This text will be sent as an interaction response.
+- Output text in your script response field.
+ This text will be sent as an interaction response.
- You can even use the `ephemeralResponse` function to make it _ephemeral_.
- Use the `sendResponse` function to send a response as soon as the function runs.
- You can also use this to send `embeds` or `complexMessages`.
- You'll need to send a `complexMessage` and pass it `"ephemeral" true` as an argument to send _ephemeral_ messages.
- `sendResponse` comes in `NoEscape` and `RetID` variants too.
- When sending an initial response, `sendResponse` does not need an interaction token, `nil` can be used.
-- Use the `sendModal` function to show the user a modal. You cannot respond to a user submitting a modal by sending them
- another modal.
-- Use the `updateMessage` function to edit the message the command triggered from. This works the same way as editing a
- message, however because it automatically targets the triggering message, the only argument required is the new
- message.
+- Use the `sendModal` function to show the user a modal.
+ You cannot respond to a user submitting a modal by sending them another modal.
+- Use the `updateMessage` function to edit the message the command triggered from.
+ This works the same way as editing a message, however because it automatically targets the triggering message, the only argument required is the new message.
[Interaction Function documentation](/docs/reference/templates/functions#interactions)
## Following Up
-Followups allow you to continue responding to an interaction after the initial response has been made. You can followup
-for up to 15 minutes after the user interacts, and you can follow up as many times as you'd like. Followups require the
-interaction token of the interaction they should be following up on.
+Followups allow you to continue responding to an interaction after the initial response has been made.
+You can followup for up to 15 minutes after the user interacts, and you can follow up as many times as you'd like.
+Followups require the interaction token of the interaction they should be following up on.
Possible followups:
-- Output text in your script response field. This text will be sent as an interaction followup.
+- Output text in your script response field.
+ This text will be sent as an interaction followup.
- You can even use the `ephemeralResponse` function to make it _ephemeral_.
-- Use the `sendResponse` function to send a followup as soon as the function runs. Note that this function morphs into
- sending followups if an initial response has already been made.
+- Use the `sendResponse` function to send a followup as soon as the function runs.
+ Note that this function morphs into sending followups if an initial response has already been made.
- You can also use this to send `embeds` or `complexMessages`.
- `sendResponse` comes in `NoEscape` and `RetID` variants too.
- - It's important to capture the message ID of any
- followups you'll want to edit or retrieve later, especially if you follow up ephemerally. If you follow up
- ephemerally without saving the message ID, you'll never be able to interface with that message again.
+ - It's important to capture the message ID of any followups you'll want to edit or retrieve later, especially if you follow up ephemerally.
+ If you follow up ephemerally without saving the message ID, you'll never be able to interface with that message again.
- Use the `editResponse` function to edit an initial response or a followup message.
- When editing an initial response, the `messageID` argument should be `nil`.
- When editing a followup message, the `messageID` argument is required.
@@ -66,8 +62,8 @@ Possible followups:
## Snippet
-Here is a basic scenario where you need to use `editResponse` and `getResponse` to work with an _ephemeral_ followup
-message. You cannot use the standard `editMessage` or `getMessage` for this because it is an ephemeral message.
+Here is a basic scenario where you need to use `editResponse` and `getResponse` to work with an _ephemeral_ followup message.
+You cannot use the standard `editMessage` or `getMessage` for this because it is an ephemeral message.
```yag
{{ $interactionToken := .Interaction.Token }}
diff --git a/content/learn/beginner/command-arguments.md b/content/learn/beginner/command-arguments.md
index c9889ef7..ef4e4e14 100644
--- a/content/learn/beginner/command-arguments.md
+++ b/content/learn/beginner/command-arguments.md
@@ -4,20 +4,21 @@ weight = 240
description = "Learn how to parse and validate arguments for custom commands."
+++
-When we were starting to write Custom Commands, we stuck to a somewhat static custom command---one that doesn't take
-any arguments and has a fixed output. This is a good starting point, but it's not very useful in practice. In this
-chapter, we'll learn how to create custom commands that take inputs.
+When we were starting to write Custom Commands, we stuck to a somewhat static custom command---one that doesn't take any arguments and has a fixed output.
+This is a good starting point, but it's not very useful in practice.
+In this chapter, we'll learn how to create custom commands that take inputs.
## Parsing Arguments
-Because parsing arguments is no easy task, we provide a convenience function, `parseArgs`, to parse the arguments passed
-to a custom command. For simple commands, this is the recommended way to handle user input. In a later chapter, we will
-explore a more hands-on approach to parsing arguments.
+Because parsing arguments is no easy task, we provide a convenience function, `parseArgs`, to parse the arguments passed to a custom command.
+For simple commands, this is the recommended way to handle user input.
+In a later chapter, we will explore a more hands-on approach to parsing arguments.
### Defining Arguments
-The first step is to define the arguments that the command will take. This is done using the aforementioned `parseArgs`
-function. The syntax is as follows:
+The first step is to define the arguments that the command will take.
+This is done using the aforementioned `parseArgs` function.
+The syntax is as follows:
```yag
{{ $args := parseArgs required_args error_message ...cargs }}
@@ -25,12 +26,13 @@ function. The syntax is as follows:
The first argument `required_args` is the number of required arguments.
-After that, we can provide a custom error message that will be displayed if the arguments are not valid. Passing an
-empty string `""` will generate one based on the argument definitions. This is useful for providing more context to
-the user about what went wrong.
+After that, we can provide a custom error message that will be displayed if the arguments are not valid.
+Passing an empty string `""` will generate one based on the argument definitions.
+This is useful for providing more context to the user about what went wrong.
The `...carg` is a variadic argument, that is, it can take any number of arguments.
-Each `carg` is a single argument definition. The `carg` function has the following syntax:
+Each `carg` is a single argument definition.
+The `carg` function has the following syntax:
```yag
{{ carg <"type"> <"description"> }}
@@ -54,11 +56,10 @@ Following types are supported:
[channel object]: /docs/reference/templates/syntax-and-data/#channel
[role object]: https://discord.com/developers/docs/topics/permissions#role-object
-The `description` is a human-readable description of the argument. This is used in the error message if the argument is
-not valid.
+The `description` is a human-readable description of the argument.
+This is used in the error message if the argument is not valid.
-Combining all of this, let's create a custom command that takes two arguments: a coolness level and a user that is part
-of the server to apply said level to.
+Combining all of this, let's create a custom command that takes two arguments: a coolness level and a user that is part of the server to apply said level to.
```yag
{{ $args := parseArgs 2 "" (carg "int" "coolness level") (carg "member" "target member") }}
@@ -66,15 +67,17 @@ of the server to apply said level to.
### Accessing Arguments
-Currently, our code doesn't do anything with the arguments. To access the arguments, we use the `.Get` method on the
-`$args` variable. The syntax is as follows:
+Currently, our code doesn't do anything with the arguments.
+To access the arguments, we use the `.Get` method on the `$args` variable.
+The syntax is as follows:
```yag
{{ $args.Get }}
```
-The `index` is the position of the argument, starting from 0. The arguments are stored in the order they are defined in
-the `parseArgs` function call. Let us now modify our custom command to access these arguments:
+The `index` is the position of the argument, starting from 0.
+The arguments are stored in the order they are defined in the `parseArgs` function call.
+Let us now modify our custom command to access these arguments:
```yag
{{ $args := parseArgs 2 "" (carg "int" "coolness level") (carg "member" "target member") }}
@@ -87,7 +90,8 @@ member: {{ ($args.Get 1).Nick }}
#### Specifying Valid Ranges
-Now, we want to limit the coolness level to a number between 0 and 100. We can do this by adding a simple check:
+Now, we want to limit the coolness level to a number between 0 and 100.
+We can do this by adding a simple check:
```yag
{{ $args := parseArgs 2 "" (carg "int" "coolness level") (carg "member" "target member") }}
@@ -101,8 +105,8 @@ coolness: {{ $args.Get 0 }}
member: {{ ($args.Get 1).Nick }}
```
-There is one major thing to note about this code: we're starting to repeat a lot of our `$args.Get N` calls! Let's fix
-that first.
+There is one major thing to note about this code: we're starting to repeat a lot of our `$args.Get N` calls!
+Let's fix that first.
```yag
{{ $args := parseArgs 2 "" (carg "int" "coolness level") (carg "member" "target member") }}
@@ -119,9 +123,8 @@ coolness: {{ $coolness }}
member: {{ $member.Nick }}
```
-Now, we can make use of another great feature of `parseArgs`: Certain types support additional arguments that can be
-used to validate the input. For example, the `int` type supports two additional arguments that can be used to specify a
-range of valid values, such that the bot will do the validation for us.
+Now, we can make use of another great feature of `parseArgs`: Certain types support additional arguments that can be used to validate the input.
+For example, the `int` type supports two additional arguments that can be used to specify a range of valid values, such that the bot will do the validation for us.
```yag
{{ $args := parseArgs 2 "" (carg "int" "coolness level" 0 100) (carg "member" "target member") }}
@@ -139,13 +142,12 @@ Following types support these validation ranges:
- `float`
- `duration` (in [time.Duration format](/docs/reference/templates/syntax-and-data#time))
-Make sure to use these instead of manually verifying a valid range, if possible, as it makes your code cleaner and
-easier to read.
+Make sure to use these instead of manually verifying a valid range, if possible, as it makes your code cleaner and easier to read.
#### Testing For Optional Arguments
-If you have optional arguments, you can check if they were provided by using the `.IsSet` method on the `$args`
-variable. The syntax is as follows:
+If you have optional arguments, you can check if they were provided by using the `.IsSet` method on the `$args` variable.
+The syntax is as follows:
```yag
{{ $args.IsSet }}
diff --git a/content/learn/beginner/conditional-branching.md b/content/learn/beginner/conditional-branching.md
index c65ad7ee..9708c78f 100644
--- a/content/learn/beginner/conditional-branching.md
+++ b/content/learn/beginner/conditional-branching.md
@@ -4,18 +4,21 @@ weight = 230
description = "Learn how to make decisions in your custom commands using control flow."
+++
-Until now, we have just written some linear code that executes from top to bottom. However, in real-world applications,
-we often need to execute different code depending on certain states of our program. This is where _control flow_ comes
-into play.
+Until now, we have just written some linear code that executes from top to bottom.
+However, in real-world applications, we often need to execute different code depending on certain states of our program.
+This is where _control flow_ comes into play.
-You already have an intuitive understanding of control flow. For instance, when you cross the street, you look left and
-right to see if any cars are coming. If there are no cars, you cross the street. Otherwise ("else"), you wait until the
-incoming cars have passed, then check again. This is a simple example of a decision-making process.
+You already have an intuitive understanding of control flow.
+For instance, when you cross the street, you look left and right to see if any cars are coming.
+If there are no cars, you cross the street.
+Otherwise ("else"), you wait until the incoming cars have passed, then check again.
+This is a simple example of a decision-making process.
## If Statements
-The most basic form of control flow is the `if` statement. An `if` statement checks a condition and executes a block of
-code if the condition is true. If the condition is false, the block of code is skipped.
+The most basic form of control flow is the `if` statement.
+An `if` statement checks a condition and executes a block of code if the condition is true.
+If the condition is false, the block of code is skipped.
```yag
{{ if eq 5 5 }}
@@ -24,8 +27,7 @@ code if the condition is true. If the condition is false, the block of code is s
{{ end }}
```
-We use the `eq` comparison function to check whether its given arguments are equal; we will enumerate all comparison
-functions in a [later section](#comparison-actions) on this page.
+We use the `eq` comparison function to check whether its given arguments are equal; we will enumerate all comparison functions in a [later section](#comparison-actions) on this page.
We can expand this to execute a different block of code if the condition is false by using an `else` block:
@@ -37,8 +39,7 @@ We can expand this to execute a different block of code if the condition is fals
{{ end }}
```
-This can be further expanded to check multiple conditions using `else if`, which are checked sequentially until one of
-them is true:
+This can be further expanded to check multiple conditions using `else if`, which are checked sequentially until one of them is true:
```yag
{{ if eq 5 3 }}
@@ -52,12 +53,10 @@ them is true:
{{< callout context="note" title="Note: Truthiness" icon="outline/info-circle" >}}
-The condition of an `if` statement need not be a boolean: in general, an `if` statement will trigger if the condition is
-_truthy_: that is, not empty or zero. (Conversely, empty and zero values are _falsy_.)
+The condition of an `if` statement need not be a boolean: in general, an `if` statement will trigger if the condition is _truthy_: that is, not empty or zero. (Conversely, empty and zero values are _falsy_.)
-For example, consider how you would check whether a string `$s` is empty. One way is to explicitly compare the length of
-the string to zero using `if gt (len $s) 0`, but since empty strings are falsy, the more idiomatic solution is to simply
-write `if $s`, like so:
+For example, consider how you would check whether a string `$s` is empty.
+One way is to explicitly compare the length of the string to zero using `if gt (len $s) 0`, but since empty strings are falsy, the more idiomatic solution is to simply write `if $s`, like so:
```yag
{{ $s := "" }}
@@ -72,10 +71,11 @@ write `if $s`, like so:
### Guard Clauses
-As your code grows, you may find yourself nesting `if` statements inside each other. This can lead to code that is hard
-to read and understand. One way to avoid this is to use _guard clauses_. A guard clause is an `if` statement that checks
-for a condition and returns early via the `{{ return }}` action. Therefore, the condition we checked in the earlier
-`if`/`else` construct must be negated.
+As your code grows, you may find yourself nesting `if` statements inside each other.
+This can lead to code that is hard to read and understand.
+One way to avoid this is to use _guard clauses_.
+A guard clause is an `if` statement that checks for a condition and returns early via the `{{ return }}` action.
+Therefore, the condition we checked in the earlier `if`/ `else` construct must be negated.
Rewriting the second example to use these guard clauses yields the following code:
@@ -88,20 +88,20 @@ Rewriting the second example to use these guard clauses yields the following cod
Five is equal to three!
```
-Although this example may be a bit contrived, guard clauses can help you avoid deeply nested code and make your code
-easier to read, especially when you come back to it at a later date.
+Although this example may be a bit contrived, guard clauses can help you avoid deeply nested code and make your code easier to read, especially when you come back to it at a later date.
## Comparison Actions
-In programming, we can make decisions by comparing values to each other. We can compare numbers, strings, and other data
-types. The result of a comparison is a _boolean_ value, which is either `true` or `false`. Normally, comparisons are
-binary operators; however, in custom commands, we use functions to compare values.
+In programming, we can make decisions by comparing values to each other.
+We can compare numbers, strings, and other data types.
+The result of a comparison is a _boolean_ value, which is either `true` or `false`.
+Normally, comparisons are binary operators; however, in custom commands, we use functions to compare values.
{{< callout context="caution" title="Warning: Comparing Across Types" icon="outline/alert-triangle" >}}
-Just like you cannot quite compare apples and oranges, you cannot compare values of different types. For instance, you
-cannot compare a number to a string. The bot will throw an error if you try to do so, you will have to convert either of
-them to the other type first.
+Just like you cannot quite compare apples and oranges, you cannot compare values of different types.
+For instance, you cannot compare a number to a string.
+The bot will throw an error if you try to do so, you will have to convert either of them to the other type first.
{{< /callout >}}
@@ -114,22 +114,23 @@ We provide the following comparison functions in custom commands:
- `gt` (greater than `>`)
- `ge` (greater than or equal to `>=`)
-These functions can only compare basic data types as introduced in [Variables and Data Types][dtypes]. Strings
-are compared on a byte-by-byte basis. Please refer to the [functions documentation](/docs/reference/templates/functions)
-for the syntax of these functions.
+These functions can only compare basic data types as introduced in [Variables and Data Types][dtypes].
+Strings are compared on a byte-by-byte basis.
+Please refer to the [functions documentation](/docs/reference/templates/functions) for the syntax of these functions.
[dtypes]: /learn/beginner/variables-and-data-types
## Blocks And Scope
-In the previous chapter, we introduced the concept of variables. Variables are used to store values and give them a name.
-In programming, variables have a _scope_, which defines where in the code the variable can be accessed. Think of each
-scope as a "container" for things inside it.
+In the previous chapter, we introduced the concept of variables.
+Variables are used to store values and give them a name.
+In programming, variables have a _scope_, which defines where in the code the variable can be accessed.
+Think of each scope as a "container" for things inside it.
-Often, you will want to have a variable available across multiple scopes. In custom commands, the variable is accessible
-in the scope in which it was defined, as well as all nested scopes within. Let us assume that we want to assign a
-coolness value, which should be true if the user's name is "alice". We can achieve this by defining a variable in
-the outer scope and re-assigning, using the `=` operator, its value in the inner scope:
+Often, you will want to have a variable available across multiple scopes.
+In custom commands, the variable is accessible in the scope in which it was defined, as well as all nested scopes within.
+Let us assume that we want to assign a coolness value, which should be true if the user's name is "alice".
+We can achieve this by defining a variable in the outer scope and re-assigning, using the `=` operator, its value in the inner scope:
```yag
{{ $isCool := false }}
@@ -141,14 +142,14 @@ the outer scope and re-assigning, using the `=` operator, its value in the inner
Are you cool? {{ $isCool }}
```
-It is considered good practice to define variables in the smallest scope possible. This makes your code easier to read
-and understand, as you do not have to search through the entire codebase to find where a variable was defined.
+It is considered good practice to define variables in the smallest scope possible.
+This makes your code easier to read and understand, as you do not have to search through the entire codebase to find where a variable was defined.
{{< callout context="caution" title="Warning: Definition and Reassignment" icon="outline/alert-triangle" >}}
-In custom commands, you use `:=` to define a variable, and `=` to reassign a variable. The bot will not throw an error
-if you try to re-define a variable using `:=`. Rather, it will define a new variable, effectively overwriting the
-existing variable, but only within that scope---the existing variable is untouched in the outer scope.
+In custom commands, you use `:=` to define a variable, and `=` to reassign a variable.
+The bot will not throw an error if you try to re-define a variable using `:=`.
+Rather, it will define a new variable, effectively overwriting the existing variable, but only within that scope---the existing variable is untouched in the outer scope.
{{< /callout >}}
@@ -158,21 +159,19 @@ The following error appears when you are missing an `{{ end }}` action.
-Each control structure must have a corresponding `{{ end }}` action. If you forget to do so, YAGPDB will not know where
-your control structure terminates and hence issues the above error.
+Each control structure must have a corresponding `{{ end }}` action.
+If you forget to do so, YAGPDB will not know where your control structure terminates and hence issues the above error.
-To fix this error, examine each `{{ if ... }}` in your program and verify that each has a matching `{{ end }}`. (The
-same applies to other control structures introduced in future chapters, such as `{{ range ... }}`.)
+To fix this error, examine each `{{ if ... }}` in your program and verify that each has a matching `{{ end }}`. (The same applies to other control structures introduced in future chapters, such as `{{ range ... }}`.)
-If you are familiar with C-family programming languages, this error is analogous to forgetting the closing `}` of a
-block of code.
+If you are familiar with C-family programming languages, this error is analogous to forgetting the closing `}` of a block of code.
{{< /callout >}}
## With Blocks
-Just like the `if` action, `with` runs a block of code if the given expression is truthy. The only difference is that
-`with` overwrites the dot `.` with the expression if it is truthy.
+Just like the `if` action, `with` runs a block of code if the given expression is truthy.
+The only difference is that `with` overwrites the dot `.` with the expression if it is truthy.
For instance, the following program
@@ -191,23 +190,24 @@ outputs
pattern found in text; the dot "3" contains the match
```
-Note that the dot `.` has been set to `"3"`—the result of `reFind`. See if you can change the text stored in `$msg` so
-that the program hits the `else` branch instead.
+Note that the dot `.` has been set to `"3"`—the result of `reFind`.
+See if you can change the text stored in `$msg` so that the program hits the `else` branch instead.
{{< callout context="caution" title="Warning: Readability of `with` Blocks" icon="outline/alert-triangle" >}}
-Be careful not to overuse `with` blocks, as they can make your code difficult to follow. In general, prefer using
-a normal `if` conditional and only use `with` if it improves readability; do not use it just to shorten code.
+Be careful not to overuse `with` blocks, as they can make your code difficult to follow.
+In general, prefer using a normal `if` conditional and only use `with` if it improves readability; do not use it just to shorten code.
{{< /callout >}}
## Exercises
-1. Write a Custom Command to determine if the number stored in a variable `$a` is even or odd and print `Number is Even`
- or `Number is Odd` depending on the case. Verify the output for the following values of `$a`: 1, 9, 0, 10021, -5.
+1. Write a Custom Command to determine if the number stored in a variable `$a` is even or odd and print `Number is Even` or `Number is Odd` depending on the case.
+ Verify the output for the following values of `$a`: 1, 9, 0, 10021, -5.
-2. Predict the output of the following code snippets. If there is an error in the snippet, what is the cause of the
- error, and how can it be fixed? Also note down potential improvements to the code that make it easier to follow.
+2. Predict the output of the following code snippets.
+ If there is an error in the snippet, what is the cause of the error, and how can it be fixed?
+ Also note down potential improvements to the code that make it easier to follow.
```yag
{{ $num1 := 10 }}
diff --git a/content/learn/beginner/simple-responses.md b/content/learn/beginner/simple-responses.md
index 6931c902..a6ac5c07 100644
--- a/content/learn/beginner/simple-responses.md
+++ b/content/learn/beginner/simple-responses.md
@@ -4,13 +4,11 @@ weight = 210
description = "Learn how to get YAGPDB to say something!"
+++
-In this chapter, we will go over two ways to output text from a custom command: using the _response_, and later on using
-_template actions_.
+In this chapter, we will go over two ways to output text from a custom command: using the _response_, and later on using _template actions_.
## Response
-If you paste text into the response field of a custom command, the bot will respond with the same text when the command
-is triggered.
+If you paste text into the response field of a custom command, the bot will respond with the same text when the command is triggered.
For instance, create a new custom command with the following response:
@@ -30,43 +28,41 @@ This will make the bot respond "Hello World." in a new message when the command
### Actions As Output
-Earlier, we just made the bot respond with some static text. However, often we want our custom command to behave
-differently depending on input. This is where _template actions_ come in.
+Earlier, we just made the bot respond with some static text.
+However, often we want our custom command to behave differently depending on input.
+This is where _template actions_ come in.
-Template actions are a way to dynamically change the output depending on various things, such as the user who triggered
-the command, the arguments passed to the command, or even the current time.
+Template actions are a way to dynamically change the output depending on various things, such as the user who triggered the command, the arguments passed to the command, or even the current time.
-The bot evaluates the template action and replaces it with the result of the evaluation. For instance, the following
-code will make the bot respond with the server name when the command is triggered:
+The bot evaluates the template action and replaces it with the result of the evaluation.
+For instance, the following code will make the bot respond with the server name when the command is triggered:
```yag
{{ .Guild.Name }}
```
As you can see, we use double curly braces (`{{` and `}}`) to denote a template action.
-The braces are essential: without these, the bot would simply respond with the text verbatim. A common pitfall
-we often see in the support channels is something like the following:
+The braces are essential: without these, the bot would simply respond with the text verbatim.
+A common pitfall we often see in the support channels is something like the following:
```yag
Hello .User.Username!
```
-If we want to bring this a step further, we can combine the plain response with some template actions to make it a bit
-more nicer-looking:
+If we want to bring this a step further, we can combine the plain response with some template actions to make it a bit more nicer-looking:
```yag
Hey there {{ .User.Username }}!
Welcome to {{ .Guild.Name }}!
```
-Play around with this a little bit and see what you can come up with. Take a look at the
-[data reference documentation](/docs/reference/templates/syntax-and-data) to see what other data you can access.
+Play around with this a little bit and see what you can come up with.
+Take a look at the [data reference documentation](/docs/reference/templates/syntax-and-data) to see what other data you can access.
### Actions for Functions
-Custom command functions allow you to perform calculations, add or remove roles to/from a user, send messages to a
-channel, and lots more! The syntax is a little different to what you might be used to; All arguments to a function
-follow the function name itself, like so:
+Custom command functions allow you to perform calculations, add or remove roles to/from a user, send messages to a channel, and lots more!
+The syntax is a little different to what you might be used to; All arguments to a function follow the function name itself, like so:
```yag
{{ add 5 3 }}
@@ -79,14 +75,13 @@ For example:
{{ mult 5 (add 3 2) }}
```
-Just like in math, the expression inside the parentheses is evaluated first, and then that result is used in the outer
-expression.
+Just like in math, the expression inside the parentheses is evaluated first, and then that result is used in the outer expression.
-Obviously these are both quite contrived examples. We provide a list of all available functions in the
-[functions reference documentation](/docs/reference/templates/functions). Try to experiment around with some of these
-functions to get a feel for how they're used and what they do.
+Obviously these are both quite contrived examples.
+We provide a list of all available functions in the [functions reference documentation](/docs/reference/templates/functions).
+Try to experiment around with some of these functions to get a feel for how they're used and what they do.
### Actions for Control Flow
-You can also use actions to determine whether some of your code is executed depending on a condition, along with some
-more complex control flows. We will go over these in more detail in a later chapter.
+You can also use actions to determine whether some of your code is executed depending on a condition, along with some more complex control flows.
+We will go over these in more detail in a later chapter.
diff --git a/content/learn/beginner/variables-and-data-types.md b/content/learn/beginner/variables-and-data-types.md
index 571d09bf..1fec7ce8 100644
--- a/content/learn/beginner/variables-and-data-types.md
+++ b/content/learn/beginner/variables-and-data-types.md
@@ -4,16 +4,16 @@ weight = 220
description = "Learn how to store data in variables and the basic data types available."
+++
-In this chapter, we will overview how to store data in variables and the basic data types available, which include
-[strings](#strings), [numbers](#numbers), and [booleans](#booleans).
+In this chapter, we will overview how to store data in variables and the basic data types available, which include [strings](#strings), [numbers](#numbers), and [booleans](#booleans).
## Variables
-Before we go over data types, we will cover how to store data and refer to it later. We can do this by using variables.
+Before we go over data types, we will cover how to store data and refer to it later.
+We can do this by using variables.
A variable is a way to store a value and give it a name, to which you can refer back to later.
-In Custom Commands, you define a variable by starting with a `$`, its name, and the assignment operator `:=`. To
-illustrate this, consider the following example:
+In Custom Commands, you define a variable by starting with a `$`, its name, and the assignment operator `:=`.
+To illustrate this, consider the following example:
```yag
{{ $name := "Alice" }}
@@ -23,13 +23,14 @@ illustrate this, consider the following example:
{{ $name }}, aged {{ $age }}, is cool: {{ $isCool }}
```
-Later on, we may wish to reassign a new value to a variable. We can do this by using the re-assignment operator `=`.
+Later on, we may wish to reassign a new value to a variable.
+We can do this by using the re-assignment operator `=`.
When and why this becomes necessary will be discussed in a later chapter.
{{< callout context="tip" title="Tip: Troubleshooting Data Types" icon="outline/rocket" >}}
-When debugging your code, you might have to figure out the type of a certain variable. You can do this by using the
-[`printf` function](/docs/reference/templates/functions/#string-manipulation) with the `%T` format verb, like so:
+When debugging your code, you might have to figure out the type of a certain variable.
+You can do this by using the [`printf` function](/docs/reference/templates/functions/#string-manipulation) with the `%T` format verb, like so:
```yag
{{ $name := "Alice" }}
@@ -40,28 +41,31 @@ When debugging your code, you might have to figure out the type of a certain var
## Data Types
-If you're completely new to programming, you might not know what a data type is. You can think of a data type as a way
-to distinguish between different kinds of things. As a real-life analogy, you can separate food into several categories,
-such as fruits, vegetables, and meat. Each category is in that sense its own data type.
+If you're completely new to programming, you might not know what a data type is.
+You can think of a data type as a way to distinguish between different kinds of things.
+As a real-life analogy, you can separate food into several categories, such as fruits, vegetables, and meat.
+Each category is in that sense its own data type.
In programming, we have similar categories, such as numbers, strings, and booleans (true / false values).
-Each of these categories has its own set of operations that can be performed on them. For instance, you can add two
-numbers together, but you cannot add two strings together (at least not in the way you might expect).
+Each of these categories has its own set of operations that can be performed on them.
+For instance, you can add two numbers together, but you cannot add two strings together (at least not in the way you might expect).
### Strings
-A string is a sequence of zero or more characters. You can generally think of it as a word or a sentence.
-In the bot's template actions, you can create a string by enclosing some text in double quotes (`"`). For instance,
-`"Hello, world!"` is a string. We call those _double-quoted strings_.
+A string is a sequence of zero or more characters.
+You can generally think of it as a word or a sentence.
+In the bot's template actions, you can create a string by enclosing some text in double quotes (`"`).
+For instance, `"Hello, world!"` is a string.
+We call those _double-quoted strings_.
-Now, here we might run into a problem quite quickly: what if we want to include a double quote in our string? We can't
-just write `"Peter said "Hello, world!""`, as the bot would think the string ends at the quotes before `Hello` and not
-know that we want them included in the string. To solve this, we must escape the double quote by adding a backslash
-(`\`) in front of it. This tells the bot that the double quote is not the end of the string. In other words,
-`"Peter said \"Hello, world!\""` would yield the expected result.
+Now, here we might run into a problem quite quickly: what if we want to include a double quote in our string?
+We can't just write `"Peter said "Hello, world!""`, as the bot would think the string ends at the quotes before `Hello` and not know that we want them included in the string.
+To solve this, we must escape the double quote by adding a backslash (`\`) in front of it.
+This tells the bot that the double quote is not the end of the string.
+In other words, `"Peter said \"Hello, world!\""` would yield the expected result.
-To insert a newline (you would press `Enter` on your keyboard), you can use the escape sequence `\n`. For example the
-string `"Hello\nWorld!"` would result in the following output:
+To insert a newline (you would press `Enter` on your keyboard), you can use the escape sequence `\n`.
+For example the string `"Hello\nWorld!"` would result in the following output:
```txt
Hello
@@ -73,11 +77,9 @@ Please note that not all escape sequences are supported by Discord.
#### Raw String Literals
-It should become relatively clear that a lot of new lines and other special characters can make a quoted string quite
-hard to read. To make this easier, you can use backticks (`` ` ``) to create a _raw string literal_. A raw string
-literal does not attempt to interpret its contents in any way, and will simply contain the text between the opening
-`` ` `` and closing `` ` `` unmodified---we cannot even escape a backtick to include one in the string, but we will
-later cover functions that solve this special case.
+It should become relatively clear that a lot of new lines and other special characters can make a quoted string quite hard to read.
+To make this easier, you can use backticks (`` ` ` `) to create a _raw string literal_.
+A raw string literal does not attempt to interpret its contents in any way, and will simply contain the text between the opening ` ` ` `` and closing `` ` `` unmodified---we cannot even escape a backtick to include one in the string, but we will later cover functions that solve this special case.
```txt
`This is my
@@ -88,22 +90,26 @@ Look at all the new lines!`
### Numbers
-Numeric values can be represented in two ways, using integers (whole numbers) and floating-point numbers (numbers with a
-decimal point). In the bot's template actions, you can create an integer by simply writing a whole number, such as `5`.
+Numeric values can be represented in two ways, using integers (whole numbers) and floating-point numbers (numbers with a decimal point).
+In the bot's template actions, you can create an integer by simply writing a whole number, such as `5`.
For floating-point numbers, you can add a decimal point, like so: `5.0`.
#### Integers
-In the bot's template actions, integers are represented as 64-bit signed integers. This means that you can store numbers
-from `-9223372036854775808` to `9223372036854775807`. If you try to store a number outside this range, the bot will
-return an error.
+In the bot's template actions, integers are represented as 64-bit signed integers.
+This means that you can store numbers from `-9223372036854775808` to `9223372036854775807`.
+If you try to store a number outside this range, the bot will return an error.
The bot accepts several notations for integers:
-1. As a base-10 number, such as `42`. This will mean what you think, the number forty-two.
-2. As a base-16 number, such as `0x2A`. This is the [hexadecimal representation][hex] of the number forty-two.
-3. As a base-8 number, such as `0o52`. This is the [octal representation][oct] of the number forty-two.
-4. As a base-2 number, such as `0b101010`. This is the [binary representation][bin] of the number forty-two.
+1. As a base-10 number, such as `42`.
+ This will mean what you think, the number forty-two.
+2. As a base-16 number, such as `0x2A`.
+ This is the [hexadecimal representation][hex] of the number forty-two.
+3. As a base-8 number, such as `0o52`.
+ This is the [octal representation][oct] of the number forty-two.
+4. As a base-2 number, such as `0b101010`.
+ This is the [binary representation][bin] of the number forty-two.
[hex]: https://en.wikipedia.org/wiki/Hexadecimal
[oct]: https://en.wikipedia.org/wiki/Octal
@@ -111,18 +117,18 @@ The bot accepts several notations for integers:
#### Floating-Point Numbers
-We represent floating-point numbers as 64-bit IEEE-754 floating-point numbers. This means that you can store numbers
-with a precision of about 15 decimal places. If you try to store a number with more precision, the bot will round it to
-the nearest representable number.
+We represent floating-point numbers as 64-bit IEEE-754 floating-point numbers.
+This means that you can store numbers with a precision of about 15 decimal places.
+If you try to store a number with more precision, the bot will round it to the nearest representable number.
-There are a lot of ways to define a floating-point number, but the most common way is to use the decimal point, such as
-`3.14`. For a full list of ways to define a floating-point number, you can refer to the
-[Go documentation](https://golang.org/ref/spec#Floating-point_literals).
+There are a lot of ways to define a floating-point number, but the most common way is to use the decimal point, such as `3.14`.
+For a full list of ways to define a floating-point number, you can refer to the [Go documentation](https://golang.org/ref/spec#Floating-point_literals).
### Booleans
-A boolean is a data type that can only have one of two values: `true` or `false`. Booleans are used to represent the
-truth value of an expression. For instance, `5 > 3` would evaluate to `true`, while `5 < 3` would evaluate to `false`.
+A boolean is a data type that can only have one of two values: `true` or `false`.
+Booleans are used to represent the truth value of an expression.
+For instance, `5 > 3` would evaluate to `true`, while `5 < 3` would evaluate to `false`.
-You can think of it as a light switch: it can either be on (`true`) or off (`false`). Booleans are often used in
-conditional statements, such as `if` statements, to determine which branch of the code should be executed.
+You can think of it as a light switch: it can either be on (`true`) or off (`false`).
+Booleans are often used in conditional statements, such as `if` statements, to determine which branch of the code should be executed.
diff --git a/content/learn/intermediate/database.md b/content/learn/intermediate/database.md
index 3271d665..ce2b1274 100644
--- a/content/learn/intermediate/database.md
+++ b/content/learn/intermediate/database.md
@@ -4,16 +4,15 @@ weight = 340
description = "Learn how to store data across time and space with YAGPDB."
+++
-YAGPDB provides a database for use in your CCs. Entries in this database are used to store persistent data that you want
-to keep between custom command executions. You access and manipulate these entries with the [database functions][funcs],
-which we will elaborate on in this guide.
+YAGPDB provides a database for use in your CCs.
+Entries in this database are used to store persistent data that you want to keep between custom command executions.
+You access and manipulate these entries with the [database functions][funcs], which we will elaborate on in this guide.
[funcs]: /docs/reference/templates/functions#database
## Overall
-This section covers the structure of a database entry, the database's size limits, as well as the entry's size limit and
-lastly the interaction limit per custom command execution.
+This section covers the structure of a database entry, the database's size limits, as well as the entry's size limit and lastly the interaction limit per custom command execution.
### Structure of an Entry
@@ -32,24 +31,23 @@ A database entry has the following structure:
| .Value | The value of this entry. |
| .ValueSize | The size of the value in bytes. |
-The fields `.CreatedAt`, `.UpdatedAt`, and `.ExpiresAt` all evaluate to a `time.Time` object, so all
-[methods on `time.Time`](/docs/reference/templates/functions#time) are applicable.
+The fields `.CreatedAt`, `.UpdatedAt`, and `.ExpiresAt` all evaluate to a `time.Time` object, so all [methods on `time.Time`](/docs/reference/templates/functions#time) are applicable.
{{< callout context="note" title="Note: About That User ID" icon="outline/info-circle" >}}
-The user ID does not have to point to a valid Discord user—it can be any integer. For instance, it is conventional (but
-not required) to store server-global data under the user ID `0`, in which case the `UserID` field will be `0` and the
-`User` field will be invalid. See also [Global vs. User Entries](#global-vs-user-entries).
+The user ID does not have to point to a valid Discord user---it can be any integer.
+For instance, it is conventional (but not required) to store server-global data under the user ID `0`, in which case the `UserID` field will be `0` and the `User` field will be invalid.
+See also [Global vs. User Entries](#global-vs-user-entries).
{{< /callout >}}
### Size Limitations
-All things computers and data have limitations, and the YAGPDB database is no exception. However, we have tried to set
-these limits generously (within reason), and we expect most custom commands will never run afoul of them.
+All things computers and data have limitations, and the YAGPDB database is no exception.
+However, we have tried to set these limits generously (within reason), and we expect most custom commands will never run afoul of them.
-**Limit on total entries.** You can have up to `50 * member_count` entries in your server's database. If your server has
-premium activated, this limit increases to `500 * member_count`.
+**Limit on total entries.** You can have up to `50 * member_count` entries in your server's database.
+If your server has premium activated, this limit increases to `500 * member_count`.
For instance, if your server has 75 members and does not have premium, your database entry limit is
@@ -57,31 +55,25 @@ For instance, if your server has 75 members and does not have premium, your data
50 * member_count = 50 * 75 = 3750
```
-and hence if you exceed 3750 database entries, all functions that create new entries will fail with the error `Above DB
-Limit`.
+and hence if you exceed 3750 database entries, all functions that create new entries will fail with the error `Above DB Limit`.
-Note that although the entry limit is a function of your server member count, there is no per-user limit. That is, a
-single user can have more than 50 entries under their ID as long as the total number of entries in the server remains
-under the limit.
+Note that although the entry limit is a function of your server member count, there is no per-user limit.
+That is, a single user can have more than 50 entries under their ID as long as the total number of entries in the server remains under the limit.
---
-**Limits on individual entries.** Database entry keys are limited to 256 bytes in length; `dbSet` and `dbSetExpire` will
-silently truncate your input key if its length exceeds this limit.
+**Limits on individual entries.** Database entry keys are limited to 256 bytes in length; `dbSet` and `dbSetExpire` will silently truncate your input key if its length exceeds this limit.
-The size of a database entry, as reported by the `ValueSize` field, is limited to 100 kB. (Internally, your data is
-serialized with [msgpack](https://msgpack.org/index.html) and the length of the serialized sequence of bytes is what
-matters.)
+The size of a database entry, as reported by the `ValueSize` field, is limited to 100 kB. (Internally, your data is serialized with [msgpack](https://msgpack.org/index.html) and the length of the serialized sequence of bytes is what matters.)
### Interaction Limits
-In addition to limiting the size of your server database, we also limit the number of times you interact with the
-database within a custom command execution. Specifically, you can only call database functions---those prefixed by `db`
----up to 10 times within a custom command execution. The limit increases to 50 if you have premium active.
+In addition to limiting the size of your server database, we also limit the number of times you interact with the database within a custom command execution.
+Specifically, you can only call database functions---those prefixed by `db` ---up to 10 times within a custom command execution.
+The limit increases to 50 if you have premium active.
-Besides the main limit, database functions that act on multiple entries, namely `dbCount`, `dbGetPattern`,
-`dbGetPatternReverse`, `dbTopEntries`, and `dbBottomEntries`, also count toward a separate limit. Specifically, these
-'multiple interaction' database functions can only be used twice in a custom command execution (10 with premium.)
+Besides the main limit, database functions that act on multiple entries, namely `dbCount`, `dbGetPattern`, `dbGetPatternReverse`, `dbTopEntries`, and `dbBottomEntries`, also count toward a separate limit.
+Specifically, these 'multiple interaction' database functions can only be used twice in a custom command execution (10 with premium.)
That concludes the overview, now let's get into basic interactions!
@@ -99,9 +91,8 @@ where `user_id` is any integer, `key` is the name of the entry, and `value` is a
{{< callout context="caution" title="Warning: Storing IDs" icon="outline/alert-triangle" >}}
-Numbers are stored as 64-bit floats internally, which can result in a loss of precision when storing IDs or similarly
-large integers. Instead, convert IDs to strings before storing them in database and convert back to integer on
-retrieval.
+Numbers are stored as 64-bit floats internally, which can result in a loss of precision when storing IDs or similarly large integers.
+Instead, convert IDs to strings before storing them in database and convert back to integer on retrieval.
See [Storing IDs](#storing-ids) for more information.
@@ -120,7 +111,8 @@ If no such entry exists, it returns `nil`.
{{< callout context="note" title="Note: Beware the Return Type" icon="outline/info-circle" >}}
-`dbGet` returns the database entry object, not the value. To access the value, read the `Value` field:
+`dbGet` returns the database entry object, not the value.
+To access the value, read the `Value` field:
```yag
{{ (dbGet user_id key).Value }}
@@ -130,8 +122,9 @@ If no such entry exists, it returns `nil`.
### dbDel
-Now we know how to create and fetch entries from the database. But a good program also frees unused storage, and custom
-commands are no exception. Use `dbDel` to delete a database entry:
+Now we know how to create and fetch entries from the database.
+But a good program also frees unused storage, and custom commands are no exception.
+Use `dbDel` to delete a database entry:
```yag
{{ dbDel user_id key }}
@@ -139,23 +132,21 @@ commands are no exception. Use `dbDel` to delete a database entry:
## Advanced Interactions
-Now, you might want to become a little more special with your database—that's why we have a few more functions,
-`dbIncr` and `dbSetExpire`. With these functions, you are able to do more complex things with the database that would
-otherwise be quite hard to achieve, or at least not very efficient.
+Now, you might want to become a little more special with your database—that's why we have a few more functions, `dbIncr` and `dbSetExpire`.
+With these functions, you are able to do more complex things with the database that would otherwise be quite hard to achieve, or at least not very efficient.
### dbIncr
-`dbIncr` increases the value of the entry by the given number and returns the incremented value in the same action,
-allowing you to further use the value. Said increment can be any valid number, that is, integers and float. Do note,
-however, that the return type of `dbIncr` is always a float, even if you use an integer for the increment argument.
+`dbIncr` increases the value of the entry by the given number and returns the incremented value in the same action, allowing you to further use the value.
+Said increment can be any valid number, that is, integers and float.
+Do note, however, that the return type of `dbIncr` is always a float, even if you use an integer for the increment argument.
```yag
{{dbIncr }}
```
-`dbIncr` also conveniently initializes a database entry to the given increment should one with the given UserID and Key
-not already exist. Try thinking about how you would implement a custom command that increases a given entry by a set
-amount, gets the value, but also sets a new entry if it doesn't already exist.
+`dbIncr` also conveniently initializes a database entry to the given increment should one with the given UserID and Key not already exist.
+Try thinking about how you would implement a custom command that increases a given entry by a set amount, gets the value, but also sets a new entry if it doesn't already exist.
```yag
{{$db := dbGet .User.ID "someKey"}}
@@ -164,16 +155,16 @@ amount, gets the value, but also sets a new entry if it doesn't already exist.
{{$add}}
```
-As you see, using only basic functions essentially requires you to waste a database function call you can probably
-better use elsewhere. And as we discussed in the beginning, those are limited at 10 (50 with premium), so quite a
-precious resource that should not be wasted.
+As you see, using only basic functions essentially requires you to waste a database function call you can probably better use elsewhere.
+And as we discussed in the beginning, those are limited at 10 (50 with premium), so quite a precious resource that should not be wasted.
### dbSetExpire
-Now you might want to set entries which get deleted after a while. To do so, you can use `dbSetExpire`.
+Now you might want to set entries which get deleted after a while.
+To do so, you can use `dbSetExpire`.
-As we recall from the beginning, database entries have an `.ExpiresAt` field of type `time.Time`. The `dbSetExpire`
-function adds a timestamp to this field, telling the bot that we only want to use the DB entry until then.
+As we recall from the beginning, database entries have an `.ExpiresAt` field of type `time.Time`.
+The `dbSetExpire` function adds a timestamp to this field, telling the bot that we only want to use the DB entry until then.
```yag
{{dbSetExpire }}
@@ -195,21 +186,23 @@ Command is not on cooldown :)
{{< callout context="note" title="Note: Backend Expiry Behavior" icon="outline/info-circle" >}}
-As a side effect, expired entries will be considered gone (i.e. deleted) by YAGPDB, but still remain in the underlying
-database. You can observe this effect by visiting your [database view page](/docs/custom-commands/database).
+As a side effect, expired entries will be considered gone (i.e. deleted) by YAGPDB, but still remain in the underlying database.
+You can observe this effect by visiting your [database view page](/docs/custom-commands/database).
{{< /callout >}}
## Multiple Interactions
-Lastly there are special functions which allow you to get multiple entries. We coincidentally call those multiple entry
-interactions. Every function except one returns a slice of entries. Depending on what function you use, this slice is
-sorted by certain criteria.
+Lastly there are special functions which allow you to get multiple entries.
+We coincidentally call those multiple entry interactions.
+Every function except one returns a slice of entries.
+Depending on what function you use, this slice is sorted by certain criteria.
### dbCount
-This is the only function interacting with multiple entries that doesn't return a slice. Since this function is fairly
-easy to understand, we'll start with that. As usual, first the syntax:
+This is the only function interacting with multiple entries that doesn't return a slice.
+Since this function is fairly easy to understand, we'll start with that.
+As usual, first the syntax:
```yag
{{dbCount }}
@@ -219,26 +212,26 @@ easy to understand, we'll start with that. As usual, first the syntax:
{{dbCount (sdict "userID" "pattern" )}}
```
-dbCount counts the entries either for the given database userID or the pattern for database keys. Alternatively, you can
-make it count entries that match both conditions by passing in an `sdict` with the keys `userID` for the ID and `pattern`
-for database keys that are to be counted. The function returns the number of entries that match the given criteria.
+dbCount counts the entries either for the given database userID or the pattern for database keys.
+Alternatively, you can make it count entries that match both conditions by passing in an `sdict` with the keys `userID` for the ID and `pattern` for database keys that are to be counted.
+The function returns the number of entries that match the given criteria.
`pattern` is a basic PostgreSQL pattern, which we explain further down in the [Patterns](#patterns) section.
### dbTopEntries / dbBottomEntries
-These functions return a slice of DB entry objects ordered by the value. `dbTopEntries` orders by descending value, and
-`dbBottomEntries` by ascending value. Both of these are hard-limited to at most 100 entries (for premium as well), and
-this can be limited further with the `amount` argument.
+These functions return a slice of DB entry objects ordered by the value. `dbTopEntries` orders by descending value, and `dbBottomEntries` by ascending value.
+Both of these are hard-limited to at most 100 entries (for premium as well), and this can be limited further with the `amount` argument.
```yag
{{dbTopEntries }}
{{dbBottomEntries }}
```
-Let's walk through these arguments one by one. For `pattern`, we use basic PostgreSQL patterns.
-The `amount` specifies how many entries we want to retrieve. Lastly, you tell YAGPDB how many entries it should skip
-using the `nSkip` argument.
+Let's walk through these arguments one by one.
+For `pattern`, we use basic PostgreSQL patterns.
+The `amount` specifies how many entries we want to retrieve.
+Lastly, you tell YAGPDB how many entries it should skip using the `nSkip` argument.
Now, to retrieve the value of each entry, we range over the given slice and access the `.Value` field:
@@ -253,9 +246,9 @@ In analogy to the above code example, you can access any other field as well.
### dbGetPattern / dbGetPatternReverse
-These two functions allow you to get multiple entries under one user ID with matching keys, again using patterns. They
-return a slice of entries sorted by value, just as the above functions. The only difference here is only the limitation
-to one `UserID` instead of all `UserID`s.
+These two functions allow you to get multiple entries under one user ID with matching keys, again using patterns.
+They return a slice of entries sorted by value, just as the above functions.
+The only difference here is only the limitation to one `UserID` instead of all `UserID`s.
```yag
{{dbGetPattern }}
@@ -263,13 +256,13 @@ to one `UserID` instead of all `UserID`s.
{{dbGetPatternReverse }}
```
-Just as above, we range over the given slice to access fields of the entry object. For simplicity's sake however, no
-code example, as it should be pretty clear how to do this.
+Just as above, we range over the given slice to access fields of the entry object.
+For simplicity's sake however, no code example, as it should be pretty clear how to do this.
### dbDelMultiple
-This function allows you to delete multiple entries in one go, instead of one at a time with `dbDel`. Its syntax is a
-little more intricate than other functions:
+This function allows you to delete multiple entries in one go, instead of one at a time with `dbDel`.
+Its syntax is a little more intricate than other functions:
```yag
{{dbDelMultiple }}
@@ -277,16 +270,16 @@ little more intricate than other functions:
`query` is a `sdict` with the following keys:
-- `userID`: delete entries under this user ID. If this key is not provided, it'll default to all IDs.
+- `userID`: delete entries under this user ID.
+ If this key is not provided, it'll default to all IDs.
- `pattern`: delete entries with keys matching this pattern.
-- `reverse`: if true, start deleting entries with the lowest value first. Defaults to `false`.
+- `reverse`: if true, start deleting entries with the lowest value first.
+ Defaults to `false`.
-`amount` specifies how many entries should be deleted in one go, maxing out at 100. `skip` specifies how many of
-matching entries should be skipped. Note that this function also returns the amount of deleted entries, which is likely
-most useful assigned to a variable.
+`amount` specifies how many entries should be deleted in one go, maxing out at 100. `skip` specifies how many of matching entries should be skipped.
+Note that this function also returns the amount of deleted entries, which is likely most useful assigned to a variable.
-With all that in mind, the following example code deletes up to 100 matching entries with `Key`s matching the pattern
-`test%` and `UserID` of the current user, finally outputting the number of entries deleted:
+With all that in mind, the following example code deletes up to 100 matching entries with `Key`s matching the pattern `test%` and `UserID` of the current user, finally outputting the number of entries deleted:
```yag
{{$deleted := dbDelMultiple (sdict "userID" .User.ID "pattern" "test%") 100 0}}
@@ -295,8 +288,7 @@ Deleted {{$deleted}} entries!
### dbRank
-This function returns the rank (that is, the position in an ordered list) of a specified entry in the set of entries
-matching criteria provided by `query`.
+This function returns the rank (that is, the position in an ordered list) of a specified entry in the set of entries matching criteria provided by `query`.
```yag
{{dbRank }}
@@ -304,12 +296,13 @@ matching criteria provided by `query`.
`query` is as above a `sdict` with the following options:
-- `userID`: search only through entries stored under this ID. Will default to all IDs, if not provided.
+- `userID`: search only through entries stored under this ID.
+ Will default to all IDs, if not provided.
- `pattern`: only count entries with matching keys; defaults to entries with any key.
-- `reverse`: if true, lower valued entries will have a higher (better) rank. Default is `false`.
+- `reverse`: if true, lower valued entries will have a higher (better) rank.
+ Default is `false`.
-As an example, to find the rank of the entry with the key `test` for the current user in all of this user's entries, you
-may want to use the following code:
+As an example, to find the rank of the entry with the key `test` for the current user in all of this user's entries, you may want to use the following code:
```yag
{{$rank := dbRank (sdict "userID" .User.ID) .User.ID "test"}}
@@ -320,19 +313,21 @@ The specified entry's rank is {{$rank}}.
### Patterns
-As mentioned earlier, we use patterns for a set of functions. Obviously, you need to know what they are and how to use
-them. The patterns are based on SQL `LIKE` patterns, so if you're familiar with them, you're good to go. If not, don't
-worry, they're quite easy to understand.
+As mentioned earlier, we use patterns for a set of functions.
+Obviously, you need to know what they are and how to use them.
+The patterns are based on SQL `LIKE` patterns, so if you're familiar with them, you're good to go.
+If not, don't worry, they're quite easy to understand.
-There's only two special characters you need to know: `%` and `_`. That's right, just those two!
-In case you need to use those literally in a pattern, escape them with a backslash (`\%` and `\_`). Their respective
-purpose is also quite simple:
+There's only two special characters you need to know: `%` and `_`.
+That's right, just those two!
+In case you need to use those literally in a pattern, escape them with a backslash (`\%` and `\_`).
+Their respective purpose is also quite simple:
- The percent sign `%` matches any sequence of zero or more characters
- The underscore `_` matches any single character
-Okay, with that in mind, let's take a look at an example. The following pattern will match anything that starts with
-the letter `l` and ends in `n`.
+Okay, with that in mind, let's take a look at an example.
+The following pattern will match anything that starts with the letter `l` and ends in `n`.
```text
l%n
@@ -348,10 +343,9 @@ This pattern matches words such as `hello`, `helgo`, `heloo`.
### Serialization
-Saving values with custom types to database may result in their values being _serialized_ to a different type, meaning
-that you might have to convert it back to its original type when retrieving. For example, saving the result of a `cembed`
-to call to database will result in it becoming a `map[string] interface{}`. The following code will showcase this
-behavior:
+Saving values with custom types to database may result in their values being _serialized_ to a different type, meaning that you might have to convert it back to its original type when retrieving.
+For example, saving the result of a `cembed` to call to database will result in it becoming a `map[string] interface{}`.
+The following code will showcase this behavior:
```yag
{{$embed := cembed "description" "Serialization!"}}
@@ -363,16 +357,14 @@ behavior:
{{dbDel .User.ID "serialization_example"}}
```
-However, most commonly used types will be saved with their type information intact, meaning that there will be no need
-to convert them after retrieval. In particular, `sdict`, `dict`, and `cslice` may be saved directly to database and will
-retain their original types.
+However, most commonly used types will be saved with their type information intact, meaning that there will be no need to convert them after retrieval.
+In particular, `sdict`, `dict`, and `cslice` may be saved directly to database and will retain their original types.
### Storing IDs
-You might have noticed that, whenever you're storing a user ID, channel ID, etc. into your database, it will come back
-as a weird value, such as `5.241379415938826e+17`. This is because they're saved as floats, hence the bot formatting it
-in scientific notation. Even converting back to an integer will not solve this, because of how floats are represented
-they will round ID numbers.
+You might have noticed that, whenever you're storing a user ID, channel ID, etc. into your database, it will come back as a weird value, such as `5.241379415938826e+17`.
+This is because they're saved as floats, hence the bot formatting it in scientific notation.
+Even converting back to an integer will not solve this, because of how floats are represented they will round ID numbers.
To prevent this, simply convert them to a string before storing and converting back to `int` upon retrieving, like so:
```yag
@@ -386,28 +378,23 @@ Try removing `str`, and observe that the IDs no longer match.
### Global vs. User Entries
-When you've been using the database for quite a while now, you surely have heard of so-called "global" and "per-user"
-entries.
+When you've been using the database for quite a while now, you surely have heard of so-called "global" and "per-user" entries.
-These terms are often used and help get the point across when explaining the _effect_, but when it comes to
-understanding the workings behind it, this is not the right way to think about it.
+These terms are often used and help get the point across when explaining the _effect_, but when it comes to understanding the workings behind it, this is not the right way to think about it.
-When you do so, you exclude all possible variations and just think "If I have a `0` as the user ID, it's a global db and
-if it's `.User.ID`, it becomes a per-user db". You block yourself from creating systems that are case-dependent,
-over-complicate things and confuse yourself.
+When you do so, you exclude all possible variations and just think "If I have a `0` as the user ID, it's a global db and if it's `.User.ID`, it becomes a per-user db".
+You block yourself from creating systems that are case-dependent, over-complicate things and confuse yourself.
-The way to go about this is to think of it in terms of the database entries themselves, and how they're used / going to
-be used in your system. As we talk about this further, we do so with the assumption that you have used at least a few
-database functions already.
+The way to go about this is to think of it in terms of the database entries themselves, and how they're used / going to be used in your system.
+As we talk about this further, we do so with the assumption that you have used at least a few database functions already.
#### Understanding a Database Entry Vaguely
-In a map, you have key-value pairs, where each value corresponds to its key. Database entries work similarly, except
-each value corresponds to the combination of the `UserID` and key. Basically, two database entries are unique if either
-the `UserID` **or** `Key` differ.
+In a map, you have key-value pairs, where each value corresponds to its key.
+Database entries work similarly, except each value corresponds to the combination of the `UserID` and key.
+Basically, two database entries are unique if either the `UserID` **or** `Key` differ.
-Each of the following line corresponds to and returns different database entries, since they don't share the same set of
-user ID and key.
+Each of the following line corresponds to and returns different database entries, since they don't share the same set of user ID and key.
```yag
{{ dbGet 20 "apple" }}
@@ -423,14 +410,13 @@ Having understood DB entries, we can now define these terms in a better way:
- **User/Channel-specific entries**: If different users/channels refer to different entries based on any set conditions,
we call them per-user entries, or similar terms.
-Before you write your code, you need to decide how your command will use the CC database and then take action
-accordingly.
+Before you write your code, you need to decide how your command will use the CC database and then take action accordingly.
-Need a different database entry in each channel that is independent of the user? Use `dbSet channelID "key" value`.
+Need a different database entry in each channel that is independent of the user?
+Use `dbSet channelID "key" value`.
Need different database entries in separate channels that are dependent on the user?
-Use `dbSet .User.ID "channelID" value` or `dbSet channelID (str .User.ID) value` depending on what kind of data you're
-expecting to get from `dbTopEntries`, or just any other custom command.
+Use `dbSet .User.ID "channelID" value` or `dbSet channelID (str .User.ID) value` depending on what kind of data you're expecting to get from `dbTopEntries`, or just any other custom command.
-It's all about playing with the `userID` and `key` to get what you need. This should hopefully give you a little better
-idea and push you to think in the right direction.
+It's all about playing with the `userID` and `key` to get what you need.
+This should hopefully give you a little better idea and push you to think in the right direction.
diff --git a/content/learn/intermediate/embeds-and-messages.md b/content/learn/intermediate/embeds-and-messages.md
index 5a259c19..5b799aaf 100644
--- a/content/learn/intermediate/embeds-and-messages.md
+++ b/content/learn/intermediate/embeds-and-messages.md
@@ -4,35 +4,36 @@ weight = 310
description = "Learn how to send messages to different channels, edit existing messages, and send messages with embeds."
+++
-Until now, we have just used the [default response behavior](/learn/beginner/simple-responses) to make our custom
-commands respond with some text. This makes sense for quick mockups or relatively simple commands. However, this may be
-inconvenient or Not What You Want in some cases. In this chapter, we will explore how to send messages to different
-channels, edit existing messages, and send messages with embeds, vastly expanding your toolbox for creating complex
-custom command systems.
+Until now, we have just used the [default response behavior](/learn/beginner/simple-responses) to make our custom commands respond with some text.
+This makes sense for quick mockups or relatively simple commands.
+However, this may be inconvenient or Not What You Want in some cases.
+In this chapter, we will explore how to send messages to different channels, edit existing messages, and send messages with embeds, vastly expanding your toolbox for creating complex custom command systems.
## Sending Messages
-We provide several `sendMessage*` functions that all do the same thing: send a message to a channel. The difference
-between them is how they handle special mentions like `@everyone` and `@here`, and whether to return the ID of the
-message after sending it. We will cover these functions in detail in the following sections, and when to best use them.
+We provide several `sendMessage*` functions that all do the same thing: send a message to a channel.
+The difference between them is how they handle special mentions like `@everyone` and `@here`, and whether to return the ID of the message after sending it.
+We will cover these functions in detail in the following sections, and when to best use them.
-Let's get started with the simplest of them all, `sendMessage`. Its syntax is the following:
+Let's get started with the simplest of them all, `sendMessage`.
+Its syntax is the following:
```yag
{{ sendMessage channel_id message_to_be_sent }}
```
-The `channel_id` is the ID of the channel to send the message to. If you want to send the message in the same channel as
-the one in which the custom command was triggered, simply set `channel_id` to `nil`.
+The `channel_id` is the ID of the channel to send the message to.
+If you want to send the message in the same channel as the one in which the custom command was triggered, simply set `channel_id` to `nil`.
-Intuitively, `message_to_be_sent` denotes the output that is to be sent as a message. For now, we will just use a string
-with the content you want to send. We will cover sending embeds in a later section on this page.
+Intuitively, `message_to_be_sent` denotes the output that is to be sent as a message.
+For now, we will just use a string with the content you want to send.
+We will cover sending embeds in a later section on this page.
### Special Mentions
-By default, the bot will escape special mentions like `@everyone`, `@here`, and role mentions (note that user mentions
-are not escaped by default). If you want to send a message with these mentions, you'll need to tell the bot to not
-escape them. You can do this by using the `sendMessageNoEscape` function instead of `sendMessage`.
+By default, the bot will escape special mentions like `@everyone`, `@here`, and role mentions (note that user mentions are not escaped by default).
+If you want to send a message with these mentions, you'll need to tell the bot to not escape them.
+You can do this by using the `sendMessageNoEscape` function instead of `sendMessage`.
```yag
{{ sendMessageNoEscape channel_id message_to_be_sent }}
@@ -40,8 +41,7 @@ escape them. You can do this by using the `sendMessageNoEscape` function instead
### Returning the Message ID
-If you want to store the ID of the message you just sent, for example to later edit it, use the `sendMessageRetID`
-function and assign the result to a variable.
+If you want to store the ID of the message you just sent, for example to later edit it, use the `sendMessageRetID` function and assign the result to a variable.
```yag
{{ $messageID := sendMessageRetID channel_id message_to_be_sent }}
@@ -57,12 +57,12 @@ It is quite the mouthful to write, but just roll with it.
## Building Embeds
-Embeds are a powerful way to display information in a structured and visually appealing way. They can contain a title,
-description, fields, images, and more. We provide a function to build embeds in a way that closely resembles the
-structure as defined by the Discord API.
+Embeds are a powerful way to display information in a structured and visually appealing way.
+They can contain a title, description, fields, images, and more.
+We provide a function to build embeds in a way that closely resembles the structure as defined by the Discord API.
-We will illustrate this with a simple example. For a full breakdown of all available fields, please refer to our
-[custom embeds documentation](/docs/reference/custom-embeds).
+We will illustrate this with a simple example.
+For a full breakdown of all available fields, please refer to our [custom embeds documentation](/docs/reference/custom-embeds).
```yag
{{ $embed := cembed
@@ -87,22 +87,21 @@ We will illustrate this with a simple example. For a full breakdown of all avail
-The above code will generate an embed as shown on the left. Let us dissect it a bit. First, we simply define a variable
-`$embed` and assign it the result of the `cembed` function. This function takes a series of key-value pairs, where the
-key is the embed field you want to set, and the value is the value you want to set for that field. The `cembed` function
-will return a structured object that can be sent as a message, as demonstrated in the last line of the code.
+The above code will generate an embed as shown on the left.
+Let us dissect it a bit.
+First, we simply define a variable `$embed` and assign it the result of the `cembed` function.
+This function takes a series of key-value pairs, where the key is the embed field you want to set, and the value is the value you want to set for that field.
+The `cembed` function will return a structured object that can be sent as a message, as demonstrated in the last line of the code.
-The `"title"` and `"description"` fields are self-explanatory---we can use Discord Markdown in the latter. The `"color"`
-field takes an integer color value, for which we can conveniently use hexadecimal formatting as mentioned in
-[Variables and Data Types](/learn/beginner/variables-and-data-types#integers), but it can also take a
-[decimal value](https://www.binaryhexconverter.com/hex-to-decimal-converter).
+The `"title"` and `"description"` fields are self-explanatory---we can use Discord Markdown in the latter.
+The `"color"` field takes an integer color value, for which we can conveniently use hexadecimal formatting as mentioned in [Variables and Data Types](/learn/beginner/variables-and-data-types#integers), but it can also take a [decimal value](https://www.binaryhexconverter.com/hex-to-decimal-converter).
-The `"fields"` field is a list (more precisely a _slice_) of dictionaries, where each dictionary represents a field in
-the embed. Each field dictionary must contain a `"name"` and a `"value"` field, and can optionally contain an `"inline"`
-field. This field is a boolean that determines whether the field should be displayed inline with the previous field.
+The `"fields"` field is a list (more precisely a _slice_) of dictionaries, where each dictionary represents a field in the embed.
+Each field dictionary must contain a `"name"` and a `"value"` field, and can optionally contain an `"inline"` field.
+This field is a boolean that determines whether the field should be displayed inline with the previous field.
-The `"author"` field is a dictionary that contains the name and icon URL of the author of the embed. In this case, we
-use the username of the user who triggered the custom command as the name, and the user's avatar URL as the icon URL.
+The `"author"` field is a dictionary that contains the name and icon URL of the author of the embed.
+In this case, we use the username of the user who triggered the custom command as the name, and the user's avatar URL as the icon URL.
{{< callout context="tip" title="Tip: Custom Commands Embed Generator" icon="outline/rocket" >}}
@@ -118,18 +117,18 @@ For your convenience, we have [prefilled the above example][prefill] in the visu
## Editing Messages
-Sending a message is nice and all, but for the sake of keeping things clean, you might want to edit a message instead of
-creating a new one each time something changes. We provide the `editMessage` function for this purpose.
+Sending a message is nice and all, but for the sake of keeping things clean, you might want to edit a message instead of creating a new one each time something changes.
+We provide the `editMessage` function for this purpose.
```yag
{{ editMessage channel_id message_id new_message_content }}
```
-The `channel_id` is the ID of the channel containing the message. The `message_id` is the ID of the message you want to
-edit. The `new_message_content` is the new content of the message, which will completely overwrite the existing content.
-See [Editing Embeds](#editing-embeds) if you only want to change certain fields of an existing embed while leaving
-others intact. You should note that YAGPDB can only edit messages from itself, just like you cannot edit someone else's
-messages.
+The `channel_id` is the ID of the channel containing the message.
+The `message_id` is the ID of the message you want to edit.
+The `new_message_content` is the new content of the message, which will completely overwrite the existing content.
+See [Editing Embeds](#editing-embeds) if you only want to change certain fields of an existing embed while leaving others intact.
+You should note that YAGPDB can only edit messages from itself, just like you cannot edit someone else's messages.
For a quick demonstration, consider the following code:
@@ -139,14 +138,12 @@ For a quick demonstration, consider the following code:
{{ editMessage nil $messageID "Goodbye, World!" }}
```
-This code sends a message saying "Hello, World!" and then, after 5 seconds, edits the message to say "Goodbye, World!",
-all in the same channel where the custom command was triggered.
+This code sends a message saying "Hello, World!" and then, after 5 seconds, edits the message to say "Goodbye, World!", all in the same channel where the custom command was triggered.
### Editing Embeds
-Editing embeds is a little more involved than editing regular messages. Since the data provided to `editMessage`
-completely overwrites the existing content, it is necessary to retrieve the existing embed object, modify the desired
-fields, and provide the whole embed to `editMessage`.
+Editing embeds is a little more involved than editing regular messages.
+Since the data provided to `editMessage` completely overwrites the existing content, it is necessary to retrieve the existing embed object, modify the desired fields, and provide the whole embed to `editMessage`.
An elaborate example all within the same custom command looks like the following:
@@ -174,18 +171,17 @@ An elaborate example all within the same custom command looks like the following
{{ editMessage nil $messageID (cembed $newEmbed) }}
```
-In the second part, after `{{ sleep 5 }}`, we first convert the original embed object to a dictionary using the
-`structToSdict` function. We then modify the fields we want to change using the `Set` method. In this case, we change
-the title and description of the embed, and remove all fields. Finally, we send the modified embed object back to the
-`editMessage` function.
+In the second part, after `{{ sleep 5 }}`, we first convert the original embed object to a dictionary using the `structToSdict` function.
+We then modify the fields we want to change using the `Set` method.
+In this case, we change the title and description of the embed, and remove all fields.
+Finally, we send the modified embed object back to the `editMessage` function.
-As mentioned previously, this example is contrived: in practice, we're more likely to use `.Message.Embeds` to get the
-original embed object, convert and modify it as shown above, then send it back to the `editMessage` function.
+As mentioned previously, this example is contrived: in practice, we're more likely to use `.Message.Embeds` to get the original embed object, convert and modify it as shown above, then send it back to the `editMessage` function.
{{< callout context="note" title="Note: Full Conversion" icon="outline/info-circle" >}}
-`structToSdict` does not perform deep conversion. For a full conversion of an embed to a dictionary, you can use the
-following code snippet:
+`structToSdict` does not perform deep conversion.
+For a full conversion of an embed to a dictionary, you can use the following code snippet:
```yag
{{ if not .Message.Embeds }}
@@ -216,9 +212,9 @@ following code snippet:
## Complex Message Builder
-We learned how to send messages and embeds individually---we can also combine them in a single message. This is where we
-have to use the `complexMessage` builder function. In this case, we will use the `"content"` and `"embed"` key to set
-the respective parts of our message:
+We learned how to send messages and embeds individually---we can also combine them in a single message.
+This is where we have to use the `complexMessage` builder function.
+In this case, we will use the `"content"` and `"embed"` key to set the respective parts of our message:
```yag
{{ $embed := cembed
@@ -243,8 +239,9 @@ the respective parts of our message:
{{ sendMessage nil $message }}
```
-Similarly, we provide a `complexMessageEdit` function to edit messages with both content and embeds. The syntax is the
-same as `complexMessage`, minus a few keys that cannot be edited. Please refer to the documentation below.
+Similarly, we provide a `complexMessageEdit` function to edit messages with both content and embeds.
+The syntax is the same as `complexMessage`, minus a few keys that cannot be edited.
+Please refer to the documentation below.
The `complexMessage` builder takes a lot more keys that give you fine-grained control over the message you want to send.
Refer to the [message functions documentation][message-docs] for a complete description.
diff --git a/content/learn/intermediate/exercises.md b/content/learn/intermediate/exercises.md
index 4540403b..ef56c64b 100644
--- a/content/learn/intermediate/exercises.md
+++ b/content/learn/intermediate/exercises.md
@@ -4,14 +4,15 @@ weight = 350
description = "Exercise your skills with these custom command challenges."
+++
-Below are some exercises to help you practice and reinforce your understanding of the concepts discussed in the previous
-sections. Remember to use the [template reference](/docs/reference/templates) if you need help. Do them at your own pace
-and whenever you feel like it.
+Below are some exercises to help you practice and reinforce your understanding of the concepts discussed in the previous sections.
+Remember to use the [template reference](/docs/reference/templates) if you need help.
+Do them at your own pace and whenever you feel like it.
## Duplicates in a List
-1. You are given a list of numbers having some repeated digits. Write a CC which will eliminate duplicate entries and
- return the cleaned list. The list is as follows: `42 1 2 81 3 5 42 19 2 42 19 81 46`.
+1. You are given a list of numbers having some repeated digits.
+ Write a CC which will eliminate duplicate entries and return the cleaned list.
+ The list is as follows: `42 1 2 81 3 5 42 19 2 42 19 81 46`.
2. Have the CC take a list of numbers as an argument instead and then return the cleaned list.
@@ -29,24 +30,22 @@ Write a CC that will take a number as an argument and then print a pattern of st
## ROT13 Substitution
-[ROT13](https://en.wikipedia.org/wiki/ROT13) ("rotate by 13 places", sometimes hyphenated ROT-13) is a simple letter
-substitution cipher that replaces a letter with the 13th letter after it, in the alphabet. Because there are 26 letters
-(2×13) in the basic Latin alphabet, ROT13 is its own inverse; that is, to undo ROT13, the same algorithm is applied, so
-the same action can be used for encoding and decoding. The algorithm provides virtually no cryptographic security, and
-is often cited as a canonical example of weak encryption.
+[ROT13](https://en.wikipedia.org/wiki/ROT13) ("rotate by 13 places", sometimes hyphenated ROT-13) is a simple letter substitution cipher that replaces a letter with the 13th letter after it, in the alphabet.
+Because there are 26 letters (2×13) in the basic Latin alphabet, ROT13 is its own inverse; that is, to undo ROT13, the same algorithm is applied, so the same action can be used for encoding and decoding.
+The algorithm provides virtually no cryptographic security, and is often cited as a canonical example of weak encryption.
-1. Write a CC that takes any string and returns the ROT13 version of the string; you may assume that the character set
- is ASCII and let "space" character be counted as well. Discard numbers.
+1. Write a CC that takes any string and returns the ROT13 version of the string; you may assume that the character set is ASCII and let "space" character be counted as well.
+ Discard numbers.
2. Decode `lntcqo vf n pbby obg naq qhpxf ner onq.`
## Arithmetic Progression
-A sequence of numbers such that the difference between each term remains constant is called an
-[Arithmetic Progression](https://en.wikipedia.org/wiki/Arithmetic_progression).
+A sequence of numbers such that the difference between each term remains constant is called an [Arithmetic Progression](https://en.wikipedia.org/wiki/Arithmetic_progression).
-We start with a term {{< math >}}$a${{< /math >}} and add the common difference {{< math >}}$d${{< /math >}}. We do this
-for {{< math >}}$n${{< /math >}} times. To find the sum of any such progression, we use the following formula.
+We start with a term {{< math >}} $a${{< /math >}} and add the common difference {{< math >}} $d${{< /math >}}.
+We do this for {{< math >}} $n${{< /math >}} times.
+To find the sum of any such progression, we use the following formula.
```math {.text-center}
$$
@@ -54,6 +53,4 @@ $$
$$
```
-Write a custom command for finding the sum of {{< math >}}$n${{< /math >}} terms of an arithmetic progression,
-parameterized to {{< math >}}$a, d, n${{< /math >}}, and verify it with above formula in the same command (use the
-right-hand side of the equation).
+Write a custom command for finding the sum of {{< math >}} $n${{< /math >}} terms of an arithmetic progression, parameterized to {{< math >}} $a, d, n${{< /math >}}, and verify it with above formula in the same command (use the right-hand side of the equation).
diff --git a/content/learn/intermediate/loops.md b/content/learn/intermediate/loops.md
index dc72e78f..c8037339 100644
--- a/content/learn/intermediate/loops.md
+++ b/content/learn/intermediate/loops.md
@@ -9,19 +9,18 @@ In this chapter, we will discuss more advanced control flow actions: namely, `ra
## Loop
-Fundamentally, loops provide a way to perform repeated actions. There are two loop actions available in custom commands:
-`range`, which repeats an action for each entry in a data structure, and `while`, which repeats an action as long as a
-condition holds.
+Fundamentally, loops provide a way to perform repeated actions.
+There are two loop actions available in custom commands: `range`, which repeats an action for each entry in a data structure, and `while`, which repeats an action as long as a condition holds.
### Range
-The `range` action performs an action for each entry in a slice or map; we say that range _iterates_ over the slice or
-map. If you have experience with other programming languages, `range` is roughly equivalent to a for-each loop.
+The `range` action performs an action for each entry in a slice or map; we say that range _iterates_ over the slice or map.
+If you have experience with other programming languages, `range` is roughly equivalent to a for-each loop.
#### Ranging over slices
-We will explain how `range` works with a slice using an illustrative example. The program below iterates over a slice of
-snacks and generates a line of output for each one.
+We will explain how `range` works with a slice using an illustrative example.
+The program below iterates over a slice of snacks and generates a line of output for each one.
```yag
{{ $snacks := cslice
@@ -34,11 +33,10 @@ snacks and generates a line of output for each one.
{{ end }}
```
-The loop body—that is, the code between the opening `range $snacks` and the closing `end`—is executed
-multiple times, with the dot `.` set to each element of the slice in succession.
+The loop body—that is, the code between the opening `range $snacks` and the closing `end`—is executed multiple times, with the dot `.` set to each element of the slice in succession.
-For instance, in the first iteration, the `.` holds the first element of the slice:
-`(sdict "Name" "chips" "Calories" 540)`. So
+For instance, in the first iteration, the `.` holds the first element of the slice: `(sdict "Name" "chips" "Calories" 540)`.
+So
```yag
{{ .Name }} contain {{ .Calories }} calories.
@@ -50,8 +48,7 @@ evaluates to
chips contain 540 calories.
```
-Likewise, the second iteration produces `peanuts contain 580 calories`, and the third produces `crackers contain 500 calories.`
-The complete output of the program is
+Likewise, the second iteration produces `peanuts contain 580 calories`, and the third produces `crackers contain 500 calories.` The complete output of the program is
```txt
chips contain 540 calories.
@@ -61,9 +58,8 @@ chips contain 540 calories.
crackers contain 500 calories.
```
-Notice that this output contains some unwanted whitespace: ideally, we want each snack to appear on a separate line with
-no leading indentation. However, the extra whitespace is to be expected with our current program; the range block is
-indented, and YAGPDB is simply reproducing that indentation:
+Notice that this output contains some unwanted whitespace: ideally, we want each snack to appear on a separate line with no leading indentation.
+However, the extra whitespace is to be expected with our current program; the range block is indented, and YAGPDB is simply reproducing that indentation:
```yag
{{ range $snacks }}
@@ -72,17 +68,16 @@ indented, and YAGPDB is simply reproducing that indentation:
{{ end }}
```
-To fix the excess whitespace in the output, then, one solution is to remove the corresponding whitespace in our source
-code:
+To fix the excess whitespace in the output, then, one solution is to remove the corresponding whitespace in our source code:
```yag
{{ range $snacks }}{{ .Name }} contains {{ .Calories }} calories.
{{ end }}
```
-However, though this version works, we have sacrificed readability in the process. Can we find a way to keep our source
-code indented while simultaneously hiding this indentation from the final output? It turns out that we can, by carefully
-adding _trim markers_.
+However, though this version works, we have sacrificed readability in the process.
+Can we find a way to keep our source code indented while simultaneously hiding this indentation from the final output?
+It turns out that we can, by carefully adding _trim markers_.
```yag
{{ range $snacks }}
@@ -91,27 +86,23 @@ adding _trim markers_.
{{ end }}
```
-`{{-` is a _left trim marker_ that instructs YAGPDB to ignore all leading whitespace, so this new version is
-functionally equivalent to the previous solution. A corresponding _right trim marker_, `-}}`, also exists and trims all
-trailing whitespace.
+`{{-` is a _left trim marker_ that instructs YAGPDB to ignore all leading whitespace, so this new version is functionally equivalent to the previous solution.
+A corresponding _right trim marker_, `-}}`, also exists and trims all trailing whitespace.
{{< callout context="tip" title="Tip: Trim Markers" icon="outline/rocket" >}}
Use trim markers `{{-` and `-}}` to control the whitespace output by your program.
-A mnemonic to help remember what `{{-` and `-}}` do is to view them as arrows that gobble up whitespace in the direction
-they point; for instance, `{{-` points left, and eats all whitespace to the left.
+A mnemonic to help remember what `{{-` and `-}}` do is to view them as arrows that gobble up whitespace in the direction they point; for instance, `{{-` points left, and eats all whitespace to the left.
{{< /callout >}}
#### Ranging over maps
-It is also possible to range over the (key, value) pairs of a map. To do so, assign two variables to the result of the
-range action, corresponding to the key and value respectively. (Note that the dot `.` is still overwritten when ranging
-with variables.)
+It is also possible to range over the (key, value) pairs of a map.
+To do so, assign two variables to the result of the range action, corresponding to the key and value respectively. (Note that the dot `.` is still overwritten when ranging with variables.)
-For example, the following program displays the prices of various types of fruit, formatted nicely to 2 decimal places
-with the `printf` function.
+For example, the following program displays the prices of various types of fruit, formatted nicely to 2 decimal places with the `printf` function.
```yag
{{ $fruitPrices := sdict "pineapple" 3.50 "apple" 1.50 "banana" 2.60 }}
@@ -121,10 +112,9 @@ with the `printf` function.
{{ end }}
```
-The names of the variables assigned to the key and value are arbitrary; instead of
-`range $fruit, $price := $fruitPrices`, we could also have written `range $k, $v := $fruitPrices`.
-However, if we use the names `$k`, `$v`, we must consistently refer to those in the loop body. That is, the following
-program is erroneous:
+The names of the variables assigned to the key and value are arbitrary; instead of `range $fruit, $price := $fruitPrices`, we could also have written `range $k, $v := $fruitPrices`.
+However, if we use the names `$k`, `$v`, we must consistently refer to those in the loop body.
+That is, the following program is erroneous:
```yag
{{ range $k, $v := $fruitPrices }}
@@ -135,8 +125,7 @@ program is erroneous:
{{< callout context="note" title="Note: Index-Value-Pairs of a Slice" icon="outline/info-circle" >}}
-This two-variable form of `range` can also be used with a slice, in which case the first variable tracks the position of
-the element starting from `0`.
+This two-variable form of `range` can also be used with a slice, in which case the first variable tracks the position of the element starting from `0`.
{{< /callout >}}
@@ -197,11 +186,9 @@ The following program illustrates a common error for first-time users of `range`
{{ end }}
```
-The problem is that, inside the range block, the dot `.` is overwritten by successive elements of the slice `1`, `2`,
-`3`. While this behavior is generally useful—we often _want_ to refer to the current element in a range action—it is
-counterproductive here, as `.User.Username` tries to look up the field `User` on an integer (and fails to do so.) What
-we really want is to access the global context data as it was before the range loop. One solution is to save the
-original context data in a variable prior to the loop:
+The problem is that, inside the range block, the dot `.` is overwritten by successive elements of the slice `1`, `2`, `3`.
+While this behavior is generally useful—we often _want_ to refer to the current element in a range action—it is counterproductive here, as `.User.Username` tries to look up the field `User` on an integer (and fails to do so.) What we really want is to access the global context data as it was before the range loop.
+One solution is to save the original context data in a variable prior to the loop:
```yag
{{ $dot := . }}
@@ -210,13 +197,12 @@ original context data in a variable prior to the loop:
{{ end }}
```
-To make this pattern easier, before each custom command execution, YAGPDB predefines the variable `$` as the initial
-context data for you.
+To make this pattern easier, before each custom command execution, YAGPDB predefines the variable `$` as the initial context data for you.
{{< callout context="caution" title="Accessing Global Context Data" icon="outline/alert-triangle" >}}
-In a range block, the dot is overwritten by elements of the slice or map, so code such as `.User.Username` is likely to
-error. If you need to access the global context data, do so through the predefined `$` variable instead.
+In a range block, the dot is overwritten by elements of the slice or map, so code such as `.User.Username` is likely to error.
+If you need to access the global context data, do so through the predefined `$` variable instead.
```yag
{{ range ... }}
@@ -228,10 +214,11 @@ error. If you need to access the global context data, do so through the predefin
### While
-`while` loops as long as the specified condition is truthy. Unlike the `range` action, the dot `.` is not affected.
+`while` loops as long as the specified condition is truthy.
+Unlike the `range` action, the dot `.` is not affected.
-For instance, the following code loops as long as `$n` is not 1. In each iteration, `$n` is updated to either `n/2` or
-`3n+1`.
+For instance, the following code loops as long as `$n` is not 1.
+In each iteration, `$n` is updated to either `n/2` or `3n+1`.
```yag
{{ $n := 19 }}
@@ -247,19 +234,16 @@ For instance, the following code loops as long as `$n` is not 1. In each iterati
{{ end }}
```
-As with `range`, it is also possible to attach a `else` branch to a `while` loop, executed if the condition is falsy
-initially.
+As with `range`, it is also possible to attach a `else` branch to a `while` loop, executed if the condition is falsy initially.
{{< callout context="tip" title="Tip: Idiomatic Iteration" icon="outline/rocket" >}}
-Many `while` loops can be written as a more idiomatic range loop instead. In particular, to iterate a fixed number of
-times, use `{{ range n }}` as in `{{ range 5 }}` instead of maintaining your own counter variable with `while`.
+Many `while` loops can be written as a more idiomatic range loop instead.
+In particular, to iterate a fixed number of times, use `{{ range n }}` as in `{{ range 5 }}` instead of maintaining your own counter variable with `while`.
{{< /callout >}}
### Break and Continue
-In custom commands, we provide two actions to control the flow of loops: `{{ break }}` and `{{ continue }}`. `break`
-exits the loop prematurely, whereas `continue` skips the remainder of the current iteration and jumps to the next one.
-These can prove very useful to optimize your code for size and readability, with similar benefits to guard clauses with
-`{{ return }}` introduced in earlier chapters.
+In custom commands, we provide two actions to control the flow of loops: `{{ break }}` and `{{ continue }}`. `break` exits the loop prematurely, whereas `continue` skips the remainder of the current iteration and jumps to the next one.
+These can prove very useful to optimize your code for size and readability, with similar benefits to guard clauses with `{{ return }}` introduced in earlier chapters.
diff --git a/content/learn/intermediate/maps-and-slices.md b/content/learn/intermediate/maps-and-slices.md
index ac5c1a28..6969d6aa 100644
--- a/content/learn/intermediate/maps-and-slices.md
+++ b/content/learn/intermediate/maps-and-slices.md
@@ -10,18 +10,16 @@ In this chapter, we will explore these data types in more detail.
## Slices
-A slice is an ordered list of items. In custom commands, we can **c**reate a **slice** by providing the items in order
-to the `cslice` function:
+A slice is an ordered list of items. In custom commands, we can **c**reate a **slice** by providing the items in order to the `cslice` function:
```yag
{{ $fruits := cslice "banana" "orange" "apple" }}
```
-All the elements in the `$fruits` slice happen to have the same type (_string_), but this is not a requirement: it is
-valid, though rare, for a slice to contain elements of different types.
+All the elements in the `$fruits` slice happen to have the same type (_string_), but this is not a requirement: it is valid, though rare, for a slice to contain elements of different types.
-Besides primitives, slices may also contain more complex data types. In previous chapters, for instance, we represented
-the fields of an embed as a slice of dictionaries.
+Besides primitives, slices may also contain more complex data types.
+In previous chapters, for instance, we represented the fields of an embed as a slice of dictionaries.
For available operations on slices, please refer to [our template documentation][docs-slices].
@@ -29,8 +27,7 @@ For available operations on slices, please refer to [our template documentation]
{{< callout context="tip" title="Tip: Truthiness of Empty Slices" icon="outline/rocket" >}}
-Empty slices are _falsy_, so can be used directly in conditional statements; it is not necessary to explicitly check the
-length:
+Empty slices are _falsy_, so can be used directly in conditional statements; it is not necessary to explicitly check the length:
```yag
{{ $users := cslice }} {{/* imagine this data is dynamically generated */}}
@@ -45,15 +42,13 @@ length:
## Maps
-A map is a table that associates values with keys, such that it is easy and efficient to retrieve the value
-corresponding to a given key.
+A map is a table that associates values with keys, such that it is easy and efficient to retrieve the value corresponding to a given key.
-For example, a program that implements a reputation system might wish to use a map from user IDs (key) to reputation
-points (value) internally. Using this map, the program can quickly look up and modify the reputation points for any
-given user.
+For example, a program that implements a reputation system might wish to use a map from user IDs (key) to reputation points (value) internally.
+Using this map, the program can quickly look up and modify the reputation points for any given user.
-Custom commands offer two kinds of maps: sdicts and dicts. A sdict only supports string keys (hence the name: **s**tring
-**dict**ionary), whereas a dict supports all [comparable data types][key-types].
+Custom commands offer two kinds of maps: sdicts and dicts.
+A sdict only supports string keys (hence the name: **s**tring **dict**ionary), whereas a dict supports all [comparable data types][key-types].
[key-types]: https://go.dev/blog/maps#key-types
@@ -93,7 +88,7 @@ yielding
map[apple:1.5 banana:2.6 pineapple:3.5]
```
-Though the output is ordered by key, this feature is only implemented for ease for debugging: maps are otherwise
-unordered data structures. If your program relies on the entries of a map being ordered, consider using a slice instead.
+Though the output is ordered by key, this feature is only implemented for ease for debugging: maps are otherwise unordered data structures.
+If your program relies on the entries of a map being ordered, consider using a slice instead.
{{< /callout >}}
diff --git a/content/learn/welcome/introduction.md b/content/learn/welcome/introduction.md
index 1a5eaade..48423e2d 100644
--- a/content/learn/welcome/introduction.md
+++ b/content/learn/welcome/introduction.md
@@ -6,38 +6,39 @@ description = "Learn how to write custom commands for YAGPDB."
> The first thing you gotta discard, whenever you're learning about something, is your ego. - Luke Smith
-These are the learning resources for YAGPDB's powerful custom command system. This is your playground!
+These are the learning resources for YAGPDB's powerful custom command system.
+This is your playground!
-We are going to teach you how to read code as well as how to write it. After all, how can you **write** if you cannot
-**read**? Learn to read, learn to solve problems, and learn to enjoy the process. The community is there to help, as
-long as you put in some effort yourself.
+We are going to teach you how to read code as well as how to write it.
+After all, how can you **write** if you cannot **read**?
+Learn to read, learn to solve problems, and learn to enjoy the process.
+The community is there to help, as long as you put in some effort yourself.
-These guides assume that you are already familiar with the custom command UI, so, for instance, you know how to add and
-edit commands through the control panel. Consult the [documentation on custom commands](/docs/custom-commands/commands)
-if unsure.
+These guides assume that you are already familiar with the custom command UI, so, for instance, you know how to add and edit commands through the control panel.
+Consult the [documentation on custom commands](/docs/custom-commands/commands) if unsure.
## General Tips
-As you start your journey with YAGPDB, there are a few things you should keep in mind. These tips will help you avoid
-common pitfalls and make your developing experience as a whole more enjoyable.
+As you start your journey with YAGPDB, there are a few things you should keep in mind.
+These tips will help you avoid common pitfalls and make your developing experience as a whole more enjoyable.
-You should start writing and testing custom commands on a separate testing server on Discord before adding them to your
-main server. This avoids any potential issues caused by members interfering with incomplete custom commands.
+You should start writing and testing custom commands on a separate testing server on Discord before adding them to your main server.
+This avoids any potential issues caused by members interfering with incomplete custom commands.
-There is no "undo" button, and kicking YAGPDB won't reset your configuration. Write your changes down first, then you
-can revert them if something goes wrong.
+There is no "undo" button, and kicking YAGPDB won't reset your configuration.
+Write your changes down first, then you can revert them if something goes wrong.
-Never assume YAGPDB is running 24/7/365: we do our best, but occasional downtime---for routine maintenance, upstream
-issues, and otherwise---is inevitable. Always have a backup plan for when YAGPDB is down.
+Never assume YAGPDB is running 24/7/365: we do our best, but occasional downtime---for routine maintenance, upstream issues, and otherwise---is inevitable.
+Always have a backup plan for when YAGPDB is down.
-Don't try to write a complex custom command right away. Start with something simple, then iteratively improve upon that.
+Don't try to write a complex custom command right away.
+Start with something simple, then iteratively improve upon that.
-Be sure to read the [reference documentation](/docs/reference/templates) alongside the lessons here. We will not cover
-every detail of every function in these lessons, rather we aim to give you the tools necessary to build complex systems.
+Be sure to read the [reference documentation](/docs/reference/templates) alongside the lessons here.
+We will not cover every detail of every function in these lessons, rather we aim to give you the tools necessary to build complex systems.
-Over time, your custom commands may get more lengthy and complex. It is a good idea to write them locally in some text
-editor or IDE, and then paste them into the web interface. Some popular choices are [VSCode], [Neovim], and
-[Notepad++].
+Over time, your custom commands may get more lengthy and complex. It is a good idea to write them locally in some text editor or IDE, and then paste them into the web interface.
+Some popular choices are [VSCode], [Neovim], and [Notepad++].
[VSCode]: https://code.visualstudio.com/
[Neovim]: https://neovim.io/
@@ -45,21 +46,18 @@ editor or IDE, and then paste them into the web interface. Some popular choices
### Planning
-Writing code is (or at least, should be), 90% planning. Investing an extra 10 minutes in carefully planning out a piece
-of code can save hours of debugging a snarled mess later on. Many novice programmers mistakenly jump right into writing
-code without a plan, only to end up pouring hours into what should be a relatively short task.
+Writing code is (or at least, should be), 90% planning.
+Investing an extra 10 minutes in carefully planning out a piece of code can save hours of debugging a snarled mess later on.
+Many novice programmers mistakenly jump right into writing code without a plan, only to end up pouring hours into what should be a relatively short task.
-Planning first is not only the best approach for novices, but also for skilled programmers. However, if you see a highly
-experienced programmer in action, you may not see them planning when working on a relatively easy problem. Not seeing
-them planning does not mean that they are not doing it, but just that they are capable of doing all the planning in
-their head.
+Planning first is not only the best approach for novices, but also for skilled programmers.
+However, if you see a highly experienced programmer in action, you may not see them planning when working on a relatively easy problem.
+Not seeing them planning does not mean that they are not doing it, but just that they are capable of doing all the planning in their head.
-As you advance in programming skill, this will eventually happen for you as well—there will be certain
-problems that you can just solve in your head and write down the solution. Of course, having practiced the skills
-required to solve harder problems will be key, as your skills will be put to better use if you work on problems at the
-difficult end of your capabilities.
+As you advance in programming skill, this will eventually happen for you as well—there will be certain problems that you can just solve in your head and write down the solution.
+Of course, having practiced the skills required to solve harder problems will be key, as your skills will be put to better use if you work on problems at the difficult end of your capabilities.
-Planning for programming primarily consists of developing the algorithm to solve the relevant problem. Once the
-algorithm is devised (and tested), translating it to code becomes relatively straightforward. Once you have implemented
-your program in code, you will need to test—and likely debug—that implementation. Having a clear plan of what the
-program _should_ do at each step makes the debugging process significantly easier.
+Planning for programming primarily consists of developing the algorithm to solve the relevant problem.
+Once the algorithm is devised (and tested), translating it to code becomes relatively straightforward.
+Once you have implemented your program in code, you will need to test—and likely debug—that implementation.
+Having a clear plan of what the program _should_ do at each step makes the debugging process significantly easier.
diff --git a/package-lock.json b/package-lock.json
index f21a1442..8004fafc 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -24,7 +24,6 @@
"thulite": "^2.6.3"
},
"devDependencies": {
- "markdownlint-cli2": "^0.18.1",
"vite": "^7.1.5"
},
"engines": {
@@ -2359,44 +2358,6 @@
"license": "MIT",
"optional": true
},
- "node_modules/@nodelib/fs.scandir": {
- "version": "2.1.5",
- "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
- "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@nodelib/fs.stat": "2.0.5",
- "run-parallel": "^1.1.9"
- },
- "engines": {
- "node": ">= 8"
- }
- },
- "node_modules/@nodelib/fs.stat": {
- "version": "2.0.5",
- "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
- "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 8"
- }
- },
- "node_modules/@nodelib/fs.walk": {
- "version": "1.2.8",
- "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
- "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@nodelib/fs.scandir": "2.1.5",
- "fastq": "^1.6.0"
- },
- "engines": {
- "node": ">= 8"
- }
- },
"node_modules/@popperjs/core": {
"version": "2.11.8",
"resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz",
@@ -2770,19 +2731,6 @@
"integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==",
"license": "MIT"
},
- "node_modules/@sindresorhus/merge-streams": {
- "version": "2.3.0",
- "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz",
- "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=18"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/@tabler/icons": {
"version": "3.34.1",
"resolved": "https://registry.npmjs.org/@tabler/icons/-/icons-3.34.1.tgz",
@@ -2869,16 +2817,6 @@
"node": ">=20.11.0"
}
},
- "node_modules/@types/debug": {
- "version": "4.1.12",
- "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz",
- "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@types/ms": "*"
- }
- },
"node_modules/@types/estree": {
"version": "1.0.8",
"resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz",
@@ -2895,13 +2833,6 @@
"@types/unist": "*"
}
},
- "node_modules/@types/katex": {
- "version": "0.16.7",
- "resolved": "https://registry.npmjs.org/@types/katex/-/katex-0.16.7.tgz",
- "integrity": "sha512-HMwFiRujE5PjrgwHQ25+bsLJgowjGjm5Z8FVSf0N6PwgJrwxH0QxzHYDcKsTfV3wva0vzrpqMTJS2jXPr5BMEQ==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/@types/mdast": {
"version": "4.0.4",
"resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz",
@@ -2911,13 +2842,6 @@
"@types/unist": "*"
}
},
- "node_modules/@types/ms": {
- "version": "2.1.0",
- "resolved": "https://registry.npmjs.org/@types/ms/-/ms-2.1.0.tgz",
- "integrity": "sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/@types/unist": {
"version": "3.0.3",
"resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz",
@@ -2992,13 +2916,6 @@
"node": ">= 8"
}
},
- "node_modules/argparse": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
- "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==",
- "dev": true,
- "license": "Python-2.0"
- },
"node_modules/autoprefixer": {
"version": "10.4.21",
"resolved": "https://registry.npmjs.org/autoprefixer/-/autoprefixer-10.4.21.tgz",
@@ -3205,17 +3122,6 @@
"url": "https://github.com/sponsors/wooorm"
}
},
- "node_modules/character-entities": {
- "version": "2.0.2",
- "resolved": "https://registry.npmjs.org/character-entities/-/character-entities-2.0.2.tgz",
- "integrity": "sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/character-entities-html4": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz",
@@ -3236,17 +3142,6 @@
"url": "https://github.com/sponsors/wooorm"
}
},
- "node_modules/character-reference-invalid": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz",
- "integrity": "sha512-iBZ4F4wRbyORVsu0jPV7gXkOsGYjGHPmAyv+HiHG8gi5PtC9KI2j1+v8/tlibRvjoWX027ypmG/n0HtO5t7unw==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/chokidar": {
"version": "3.6.0",
"resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
@@ -3483,20 +3378,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/decode-named-character-reference": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/decode-named-character-reference/-/decode-named-character-reference-1.2.0.tgz",
- "integrity": "sha512-c6fcElNV6ShtZXmsgNgFFV5tVX2PaV4g+MOAkb8eXHvn6sryJBrZa9r0zV6+dtTyoCKxtDy5tyQ5ZwQuidtd+Q==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "character-entities": "^2.0.0"
- },
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/delegate": {
"version": "3.2.0",
"resolved": "https://registry.npmjs.org/delegate/-/delegate-3.2.0.tgz",
@@ -3685,33 +3566,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/fast-glob": {
- "version": "3.3.3",
- "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz",
- "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@nodelib/fs.stat": "^2.0.2",
- "@nodelib/fs.walk": "^1.2.3",
- "glob-parent": "^5.1.2",
- "merge2": "^1.3.0",
- "micromatch": "^4.0.8"
- },
- "engines": {
- "node": ">=8.6.0"
- }
- },
- "node_modules/fastq": {
- "version": "1.19.1",
- "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz",
- "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "reusify": "^1.0.4"
- }
- },
"node_modules/fill-range": {
"version": "7.1.1",
"resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
@@ -3862,14 +3716,14 @@
}
},
"node_modules/glob": {
- "version": "11.0.3",
- "resolved": "https://registry.npmjs.org/glob/-/glob-11.0.3.tgz",
- "integrity": "sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA==",
- "license": "ISC",
+ "version": "11.1.0",
+ "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz",
+ "integrity": "sha512-vuNwKSaKiqm7g0THUBu2x7ckSs3XJLXE+2ssL7/MfTGPLLcrJQ/4Uq1CjPTtO5cCIiRxqvN6Twy1qOwhL0Xjcw==",
+ "license": "BlueOak-1.0.0",
"dependencies": {
"foreground-child": "^3.3.1",
"jackspeak": "^4.1.1",
- "minimatch": "^10.0.3",
+ "minimatch": "^10.1.1",
"minipass": "^7.1.2",
"package-json-from-dist": "^1.0.0",
"path-scurry": "^2.0.0"
@@ -4064,40 +3918,6 @@
"node": ">= 6"
}
},
- "node_modules/globby": {
- "version": "14.1.0",
- "resolved": "https://registry.npmjs.org/globby/-/globby-14.1.0.tgz",
- "integrity": "sha512-0Ia46fDOaT7k4og1PDW4YbodWWr3scS2vAr2lTbsplOt2WkKp0vQbkI9wKis/T5LV/dqPjO3bpS/z6GTJB82LA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@sindresorhus/merge-streams": "^2.1.0",
- "fast-glob": "^3.3.3",
- "ignore": "^7.0.3",
- "path-type": "^6.0.0",
- "slash": "^5.1.0",
- "unicorn-magic": "^0.3.0"
- },
- "engines": {
- "node": ">=18"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
- "node_modules/globby/node_modules/slash": {
- "version": "5.1.0",
- "resolved": "https://registry.npmjs.org/slash/-/slash-5.1.0.tgz",
- "integrity": "sha512-ZA6oR3T/pEyuqwMgAKT0/hAv8oAXckzbkmR0UkUosQ+Mc4RxGoJkRmwHgHufaenlyAgE1Mxgpdcrf75y6XcnDg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=14.16"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/gonzales-pe": {
"version": "4.3.0",
"resolved": "https://registry.npmjs.org/gonzales-pe/-/gonzales-pe-4.3.0.tgz",
@@ -4205,16 +4025,6 @@
"entities": "^4.5.0"
}
},
- "node_modules/ignore": {
- "version": "7.0.5",
- "resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.5.tgz",
- "integrity": "sha512-Hs59xBNfUIunMFgWAbGX5cq6893IbWg4KnrjbYwX3tx0ztorVgTDA6B2sxf8ejHJ4wz8BqGUMYlnzNBer5NvGg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 4"
- }
- },
"node_modules/inflight": {
"version": "1.0.6",
"resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
@@ -4241,32 +4051,6 @@
"loose-envify": "^1.0.0"
}
},
- "node_modules/is-alphabetical": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/is-alphabetical/-/is-alphabetical-2.0.1.tgz",
- "integrity": "sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
- "node_modules/is-alphanumerical": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz",
- "integrity": "sha512-hmbYhX/9MUMF5uh7tOXyK/n0ZvWpad5caBA17GsC6vyuCqaWliRG5K1qS9inmUhEMaOBIW7/whAnSwveW/LtZw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "is-alphabetical": "^2.0.0",
- "is-decimal": "^2.0.0"
- },
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/is-binary-path": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz",
@@ -4294,17 +4078,6 @@
"url": "https://github.com/sponsors/ljharb"
}
},
- "node_modules/is-decimal": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/is-decimal/-/is-decimal-2.0.1.tgz",
- "integrity": "sha512-AAB9hiomQs5DXWcRB1rqsxGUstbRroFOPPVAomNk/3XHR5JyEZChOyTWe2oayKnsSsr/kcGqF+z6yuH6HHpN0A==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/is-extglob": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
@@ -4335,17 +4108,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/is-hexadecimal": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz",
- "integrity": "sha512-DgZQp241c8oO6cA1SbTEWiXeoxV42vlcJxgH+B3hi1AiqqKruZR3ZGF8In3fj4+/y/7rHvlOZLZtgJ/4ttYGZg==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
"node_modules/is-number": {
"version": "7.0.0",
"resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
@@ -4382,19 +4144,6 @@
"integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==",
"license": "MIT"
},
- "node_modules/js-yaml": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
- "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "argparse": "^2.0.1"
- },
- "bin": {
- "js-yaml": "bin/js-yaml.js"
- }
- },
"node_modules/jsesc": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz",
@@ -4419,13 +4168,6 @@
"node": ">=6"
}
},
- "node_modules/jsonc-parser": {
- "version": "3.3.1",
- "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz",
- "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/jsonfile": {
"version": "6.2.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz",
@@ -4438,33 +4180,6 @@
"graceful-fs": "^4.1.6"
}
},
- "node_modules/katex": {
- "version": "0.16.22",
- "resolved": "https://registry.npmjs.org/katex/-/katex-0.16.22.tgz",
- "integrity": "sha512-XCHRdUw4lf3SKBaJe4EvgqIuWwkPSo9XoeO8GjQW94Bp7TWv9hNhzZjZ+OH9yf1UmLygb7DIT5GSFQiyt16zYg==",
- "dev": true,
- "funding": [
- "https://opencollective.com/katex",
- "https://github.com/sponsors/katex"
- ],
- "license": "MIT",
- "dependencies": {
- "commander": "^8.3.0"
- },
- "bin": {
- "katex": "cli.js"
- }
- },
- "node_modules/katex/node_modules/commander": {
- "version": "8.3.0",
- "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz",
- "integrity": "sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 12"
- }
- },
"node_modules/lazysizes": {
"version": "5.3.2",
"resolved": "https://registry.npmjs.org/lazysizes/-/lazysizes-5.3.2.tgz",
@@ -4483,16 +4198,6 @@
"url": "https://github.com/sponsors/antonk52"
}
},
- "node_modules/linkify-it": {
- "version": "5.0.0",
- "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz",
- "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "uc.micro": "^2.0.0"
- }
- },
"node_modules/locate-path": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz",
@@ -4560,85 +4265,6 @@
"semver": "bin/semver"
}
},
- "node_modules/markdown-it": {
- "version": "14.1.0",
- "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz",
- "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "argparse": "^2.0.1",
- "entities": "^4.4.0",
- "linkify-it": "^5.0.0",
- "mdurl": "^2.0.0",
- "punycode.js": "^2.3.1",
- "uc.micro": "^2.1.0"
- },
- "bin": {
- "markdown-it": "bin/markdown-it.mjs"
- }
- },
- "node_modules/markdownlint": {
- "version": "0.38.0",
- "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.38.0.tgz",
- "integrity": "sha512-xaSxkaU7wY/0852zGApM8LdlIfGCW8ETZ0Rr62IQtAnUMlMuifsg09vWJcNYeL4f0anvr8Vo4ZQar8jGpV0btQ==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "micromark": "4.0.2",
- "micromark-core-commonmark": "2.0.3",
- "micromark-extension-directive": "4.0.0",
- "micromark-extension-gfm-autolink-literal": "2.1.0",
- "micromark-extension-gfm-footnote": "2.1.0",
- "micromark-extension-gfm-table": "2.1.1",
- "micromark-extension-math": "3.1.0",
- "micromark-util-types": "2.0.2"
- },
- "engines": {
- "node": ">=20"
- },
- "funding": {
- "url": "https://github.com/sponsors/DavidAnson"
- }
- },
- "node_modules/markdownlint-cli2": {
- "version": "0.18.1",
- "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.18.1.tgz",
- "integrity": "sha512-/4Osri9QFGCZOCTkfA8qJF+XGjKYERSHkXzxSyS1hd3ZERJGjvsUao2h4wdnvpHp6Tu2Jh/bPHM0FE9JJza6ng==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "globby": "14.1.0",
- "js-yaml": "4.1.0",
- "jsonc-parser": "3.3.1",
- "markdown-it": "14.1.0",
- "markdownlint": "0.38.0",
- "markdownlint-cli2-formatter-default": "0.0.5",
- "micromatch": "4.0.8"
- },
- "bin": {
- "markdownlint-cli2": "markdownlint-cli2-bin.mjs"
- },
- "engines": {
- "node": ">=20"
- },
- "funding": {
- "url": "https://github.com/sponsors/DavidAnson"
- }
- },
- "node_modules/markdownlint-cli2-formatter-default": {
- "version": "0.0.5",
- "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.5.tgz",
- "integrity": "sha512-4XKTwQ5m1+Txo2kuQ3Jgpo/KmnG+X90dWt4acufg6HVGadTUG5hzHF/wssp9b5MBYOMCnZ9RMPaU//uHsszF8Q==",
- "dev": true,
- "license": "MIT",
- "funding": {
- "url": "https://github.com/sponsors/DavidAnson"
- },
- "peerDependencies": {
- "markdownlint-cli2": ">=0.0.4"
- }
- },
"node_modules/mdast-util-to-hast": {
"version": "13.2.0",
"resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz",
@@ -4660,28 +4286,10 @@
"url": "https://opencollective.com/unified"
}
},
- "node_modules/mdurl": {
- "version": "2.0.0",
- "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz",
- "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==",
- "dev": true,
- "license": "MIT"
- },
- "node_modules/merge2": {
- "version": "1.4.1",
- "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
- "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">= 8"
- }
- },
- "node_modules/micromark": {
- "version": "4.0.2",
- "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.2.tgz",
- "integrity": "sha512-zpe98Q6kvavpCr1NPVSCMebCKfD7CA2NqZ+rykeNhONIJBpc1tFKt9hucLGwha3jNTNI8lHpctWJWoimVF4PfA==",
- "dev": true,
+ "node_modules/micromark-util-character": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz",
+ "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==",
"funding": [
{
"type": "GitHub Sponsors",
@@ -4694,30 +4302,14 @@
],
"license": "MIT",
"dependencies": {
- "@types/debug": "^4.0.0",
- "debug": "^4.0.0",
- "decode-named-character-reference": "^1.0.0",
- "devlop": "^1.0.0",
- "micromark-core-commonmark": "^2.0.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-chunked": "^2.0.0",
- "micromark-util-combine-extensions": "^2.0.0",
- "micromark-util-decode-numeric-character-reference": "^2.0.0",
- "micromark-util-encode": "^2.0.0",
- "micromark-util-normalize-identifier": "^2.0.0",
- "micromark-util-resolve-all": "^2.0.0",
- "micromark-util-sanitize-uri": "^2.0.0",
- "micromark-util-subtokenize": "^2.0.0",
"micromark-util-symbol": "^2.0.0",
"micromark-util-types": "^2.0.0"
}
},
- "node_modules/micromark-core-commonmark": {
- "version": "2.0.3",
- "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.3.tgz",
- "integrity": "sha512-RDBrHEMSxVFLg6xvnXmb1Ayr2WzLAWjeSATAoxwKYJV94TeNavgoIdA0a9ytzDSVzBy2YKFK+emCPOEibLeCrg==",
- "dev": true,
+ "node_modules/micromark-util-encode": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz",
+ "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==",
"funding": [
{
"type": "GitHub Sponsors",
@@ -4728,409 +4320,7 @@
"url": "https://opencollective.com/unified"
}
],
- "license": "MIT",
- "dependencies": {
- "decode-named-character-reference": "^1.0.0",
- "devlop": "^1.0.0",
- "micromark-factory-destination": "^2.0.0",
- "micromark-factory-label": "^2.0.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-factory-title": "^2.0.0",
- "micromark-factory-whitespace": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-chunked": "^2.0.0",
- "micromark-util-classify-character": "^2.0.0",
- "micromark-util-html-tag-name": "^2.0.0",
- "micromark-util-normalize-identifier": "^2.0.0",
- "micromark-util-resolve-all": "^2.0.0",
- "micromark-util-subtokenize": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-extension-directive": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/micromark-extension-directive/-/micromark-extension-directive-4.0.0.tgz",
- "integrity": "sha512-/C2nqVmXXmiseSSuCdItCMho7ybwwop6RrrRPk0KbOHW21JKoCldC+8rFOaundDoRBUWBnJJcxeA/Kvi34WQXg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "devlop": "^1.0.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-factory-whitespace": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0",
- "parse-entities": "^4.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/unified"
- }
- },
- "node_modules/micromark-extension-gfm-autolink-literal": {
- "version": "2.1.0",
- "resolved": "https://registry.npmjs.org/micromark-extension-gfm-autolink-literal/-/micromark-extension-gfm-autolink-literal-2.1.0.tgz",
- "integrity": "sha512-oOg7knzhicgQ3t4QCjCWgTmfNhvQbDDnJeVu9v81r7NltNCVmhPy1fJRX27pISafdjL+SVc4d3l48Gb6pbRypw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "micromark-util-character": "^2.0.0",
- "micromark-util-sanitize-uri": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/unified"
- }
- },
- "node_modules/micromark-extension-gfm-footnote": {
- "version": "2.1.0",
- "resolved": "https://registry.npmjs.org/micromark-extension-gfm-footnote/-/micromark-extension-gfm-footnote-2.1.0.tgz",
- "integrity": "sha512-/yPhxI1ntnDNsiHtzLKYnE3vf9JZ6cAisqVDauhp4CEHxlb4uoOTxOCJ+9s51bIB8U1N1FJ1RXOKTIlD5B/gqw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "devlop": "^1.0.0",
- "micromark-core-commonmark": "^2.0.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-normalize-identifier": "^2.0.0",
- "micromark-util-sanitize-uri": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/unified"
- }
- },
- "node_modules/micromark-extension-gfm-table": {
- "version": "2.1.1",
- "resolved": "https://registry.npmjs.org/micromark-extension-gfm-table/-/micromark-extension-gfm-table-2.1.1.tgz",
- "integrity": "sha512-t2OU/dXXioARrC6yWfJ4hqB7rct14e8f7m0cbI5hUmDyyIlwv5vEtooptH8INkbLzOatzKuVbQmAYcbWoyz6Dg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "devlop": "^1.0.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/unified"
- }
- },
- "node_modules/micromark-extension-math": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/micromark-extension-math/-/micromark-extension-math-3.1.0.tgz",
- "integrity": "sha512-lvEqd+fHjATVs+2v/8kg9i5Q0AP2k85H0WUOwpIVvUML8BapsMvh1XAogmQjOCsLpoKRCVQqEkQBB3NhVBcsOg==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@types/katex": "^0.16.0",
- "devlop": "^1.0.0",
- "katex": "^0.16.0",
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/unified"
- }
- },
- "node_modules/micromark-factory-destination": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.1.tgz",
- "integrity": "sha512-Xe6rDdJlkmbFRExpTOmRj9N3MaWmbAgdpSrBQvCFqhezUn4AHqJHbaEnfbVYYiexVSs//tqOdY/DxhjdCiJnIA==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-factory-label": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.1.tgz",
- "integrity": "sha512-VFMekyQExqIW7xIChcXn4ok29YE3rnuyveW3wZQWWqF4Nv9Wk5rgJ99KzPvHjkmPXF93FXIbBp6YdW3t71/7Vg==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "devlop": "^1.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-factory-space": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.1.tgz",
- "integrity": "sha512-zRkxjtBxxLd2Sc0d+fbnEunsTj46SWXgXciZmHq0kDYGnck/ZSGj9/wULTV95uoeYiK5hRXP2mJ98Uo4cq/LQg==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-character": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-factory-title": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.1.tgz",
- "integrity": "sha512-5bZ+3CjhAd9eChYTHsjy6TGxpOFSKgKKJPJxr293jTbfry2KDoWkhBb6TcPVB4NmzaPhMs1Frm9AZH7OD4Cjzw==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-factory-whitespace": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.1.tgz",
- "integrity": "sha512-Ob0nuZ3PKt/n0hORHyvoD9uZhr+Za8sFoP+OnMcnWK5lngSzALgQYKMr9RJVOWLqQYuyn6ulqGWSXdwf6F80lQ==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-factory-space": "^2.0.0",
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-util-character": {
- "version": "2.1.1",
- "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz",
- "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==",
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-util-chunked": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.1.tgz",
- "integrity": "sha512-QUNFEOPELfmvv+4xiNg2sRYeS/P84pTW0TCgP5zc9FpXetHY0ab7SxKyAQCNCc1eK0459uoLI1y5oO5Vc1dbhA==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-symbol": "^2.0.0"
- }
- },
- "node_modules/micromark-util-classify-character": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.1.tgz",
- "integrity": "sha512-K0kHzM6afW/MbeWYWLjoHQv1sgg2Q9EccHEDzSkxiP/EaagNzCm7T/WMKZ3rjMbvIpvBiZgwR3dKMygtA4mG1Q==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-character": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-util-combine-extensions": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.1.tgz",
- "integrity": "sha512-OnAnH8Ujmy59JcyZw8JSbK9cGpdVY44NKgSM7E9Eh7DiLS2E9RNQf0dONaGDzEG9yjEl5hcqeIsj4hfRkLH/Bg==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-chunked": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
- "node_modules/micromark-util-decode-numeric-character-reference": {
- "version": "2.0.2",
- "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.2.tgz",
- "integrity": "sha512-ccUbYk6CwVdkmCQMyr64dXz42EfHGkPQlBj5p7YVGzq8I7CtjXZJrubAYezf7Rp+bjPseiROqe7G6foFd+lEuw==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-symbol": "^2.0.0"
- }
- },
- "node_modules/micromark-util-encode": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz",
- "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==",
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT"
- },
- "node_modules/micromark-util-html-tag-name": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.1.tgz",
- "integrity": "sha512-2cNEiYDhCWKI+Gs9T0Tiysk136SnR13hhO8yW6BGNyhOC4qYFnwF1nKfD3HFAIXA5c45RrIG1ub11GiXeYd1xA==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT"
- },
- "node_modules/micromark-util-normalize-identifier": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.1.tgz",
- "integrity": "sha512-sxPqmo70LyARJs0w2UclACPUUEqltCkJ6PhKdMIDuJ3gSf/Q+/GIe3WKl0Ijb/GyH9lOpUkRAO2wp0GVkLvS9Q==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-symbol": "^2.0.0"
- }
- },
- "node_modules/micromark-util-resolve-all": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.1.tgz",
- "integrity": "sha512-VdQyxFWFT2/FGJgwQnJYbe1jjQoNTS4RjglmSjTUlpUMa95Htx9NHeYW4rGDJzbjvCsl9eLjMQwGeElsqmzcHg==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "micromark-util-types": "^2.0.0"
- }
+ "license": "MIT"
},
"node_modules/micromark-util-sanitize-uri": {
"version": "2.0.1",
@@ -5153,29 +4343,6 @@
"micromark-util-symbol": "^2.0.0"
}
},
- "node_modules/micromark-util-subtokenize": {
- "version": "2.1.0",
- "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.1.0.tgz",
- "integrity": "sha512-XQLu552iSctvnEcgXw6+Sx75GflAPNED1qx7eBJ+wydBb2KCbRZe+NwvIEEMM83uml1+2WSXpBAcp9IUCgCYWA==",
- "dev": true,
- "funding": [
- {
- "type": "GitHub Sponsors",
- "url": "https://github.com/sponsors/unifiedjs"
- },
- {
- "type": "OpenCollective",
- "url": "https://opencollective.com/unified"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "devlop": "^1.0.0",
- "micromark-util-chunked": "^2.0.0",
- "micromark-util-symbol": "^2.0.0",
- "micromark-util-types": "^2.0.0"
- }
- },
"node_modules/micromark-util-symbol": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz",
@@ -5208,25 +4375,11 @@
],
"license": "MIT"
},
- "node_modules/micromatch": {
- "version": "4.0.8",
- "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
- "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "braces": "^3.0.3",
- "picomatch": "^2.3.1"
- },
- "engines": {
- "node": ">=8.6"
- }
- },
"node_modules/minimatch": {
- "version": "10.0.3",
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.3.tgz",
- "integrity": "sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw==",
- "license": "ISC",
+ "version": "10.1.1",
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.1.1.tgz",
+ "integrity": "sha512-enIvLvRAFZYXJzkCYG5RKmPfrFArdLv+R+lbQ53BmIMLIry74bjKzX6iHAm8WYamJkhSSEabrWN5D97XnKObjQ==",
+ "license": "BlueOak-1.0.0",
"dependencies": {
"@isaacs/brace-expansion": "^5.0.0"
},
@@ -5371,33 +4524,6 @@
"integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==",
"license": "BlueOak-1.0.0"
},
- "node_modules/parse-entities": {
- "version": "4.0.2",
- "resolved": "https://registry.npmjs.org/parse-entities/-/parse-entities-4.0.2.tgz",
- "integrity": "sha512-GG2AQYWoLgL877gQIKeRPGO1xF9+eG1ujIb5soS5gPvLQ1y2o8FL90w2QWNdf9I361Mpp7726c+lj3U0qK1uGw==",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "@types/unist": "^2.0.0",
- "character-entities-legacy": "^3.0.0",
- "character-reference-invalid": "^2.0.0",
- "decode-named-character-reference": "^1.0.0",
- "is-alphanumerical": "^2.0.0",
- "is-decimal": "^2.0.0",
- "is-hexadecimal": "^2.0.0"
- },
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/wooorm"
- }
- },
- "node_modules/parse-entities/node_modules/@types/unist": {
- "version": "2.0.11",
- "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.11.tgz",
- "integrity": "sha512-CmBKiL6NNo/OqgmMn95Fk9Whlp2mtvIv+KNpQKN2F4SjvrEesubTRWGYSg+BnWZOnlCaSTU1sMpsBOzgbYhnsA==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/path-exists": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz",
@@ -5447,19 +4573,6 @@
"url": "https://github.com/sponsors/isaacs"
}
},
- "node_modules/path-type": {
- "version": "6.0.0",
- "resolved": "https://registry.npmjs.org/path-type/-/path-type-6.0.0.tgz",
- "integrity": "sha512-Vj7sf++t5pBD637NSfkxpHSMfWaeig5+DKWLhcqIYx6mWQz5hdJTGDVMQiJcw1ZYkhs7AazKDGpRVji1LJCZUQ==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=18"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/picocolors": {
"version": "1.1.1",
"resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz",
@@ -5668,16 +4781,6 @@
"url": "https://github.com/sponsors/wooorm"
}
},
- "node_modules/punycode.js": {
- "version": "2.3.1",
- "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz",
- "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=6"
- }
- },
"node_modules/purgecss": {
"version": "7.0.2",
"resolved": "https://registry.npmjs.org/purgecss/-/purgecss-7.0.2.tgz",
@@ -5713,27 +4816,6 @@
"node": ">=18"
}
},
- "node_modules/queue-microtask": {
- "version": "1.2.3",
- "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
- "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
- "dev": true,
- "funding": [
- {
- "type": "github",
- "url": "https://github.com/sponsors/feross"
- },
- {
- "type": "patreon",
- "url": "https://www.patreon.com/feross"
- },
- {
- "type": "consulting",
- "url": "https://feross.org/support"
- }
- ],
- "license": "MIT"
- },
"node_modules/quicklink": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/quicklink/-/quicklink-3.0.1.tgz",
@@ -5920,17 +5002,6 @@
"url": "https://github.com/sponsors/ljharb"
}
},
- "node_modules/reusify": {
- "version": "1.1.0",
- "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz",
- "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "iojs": ">=1.0.0",
- "node": ">=0.10.0"
- }
- },
"node_modules/rollup": {
"version": "4.50.1",
"resolved": "https://registry.npmjs.org/rollup/-/rollup-4.50.1.tgz",
@@ -5984,30 +5055,6 @@
"node": ">= 6"
}
},
- "node_modules/run-parallel": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
- "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
- "dev": true,
- "funding": [
- {
- "type": "github",
- "url": "https://github.com/sponsors/feross"
- },
- {
- "type": "patreon",
- "url": "https://www.patreon.com/feross"
- },
- {
- "type": "consulting",
- "url": "https://feross.org/support"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "queue-microtask": "^1.2.2"
- }
- },
"node_modules/scss-parser": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/scss-parser/-/scss-parser-1.0.3.tgz",
@@ -6348,13 +5395,6 @@
"url": "https://github.com/sponsors/wooorm"
}
},
- "node_modules/uc.micro": {
- "version": "2.1.0",
- "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz",
- "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==",
- "dev": true,
- "license": "MIT"
- },
"node_modules/unicode-canonical-property-names-ecmascript": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz",
@@ -6395,19 +5435,6 @@
"node": ">=4"
}
},
- "node_modules/unicorn-magic": {
- "version": "0.3.0",
- "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.3.0.tgz",
- "integrity": "sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=18"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/unist-util-is": {
"version": "6.0.0",
"resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.0.tgz",
@@ -6550,9 +5577,9 @@
}
},
"node_modules/vite": {
- "version": "7.1.5",
- "resolved": "https://registry.npmjs.org/vite/-/vite-7.1.5.tgz",
- "integrity": "sha512-4cKBO9wR75r0BeIWWWId9XK9Lj6La5X846Zw9dFfzMRw38IlTk2iCcUt6hsyiDRcPidc55ZParFYDXi0nXOeLQ==",
+ "version": "7.2.4",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-7.2.4.tgz",
+ "integrity": "sha512-NL8jTlbo0Tn4dUEXEsUg8KeyG/Lkmc4Fnzb8JXN/Ykm9G4HNImjtABMJgkQoVjOBN/j2WAwDTRytdqJbZsah7w==",
"dev": true,
"license": "MIT",
"dependencies": {
diff --git a/package.json b/package.json
index 813e511a..a3c75d66 100644
--- a/package.json
+++ b/package.json
@@ -28,7 +28,6 @@
"thulite": "^2.6.3"
},
"devDependencies": {
- "markdownlint-cli2": "^0.18.1",
"vite": "^7.1.5"
},
"engines": {