Skip to content

Commit

Permalink
general: embellish click here hyperlinks
Browse files Browse the repository at this point in the history
Signed-off-by: SoggySaussages <[email protected]>
  • Loading branch information
SoggySaussages committed Jun 11, 2024
1 parent 5f14458 commit 9680e19
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 39 deletions.
4 changes: 2 additions & 2 deletions content/fun/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight = 7

Fun commands and systems provide engaging ways to enrich your server environment.

This chapter documents the fun systems which offer additional configuration via the control panel. To see all fun
commands, [click here](/core/all-commands#fun)
This chapter documents the fun systems which offer additional configuration via the control panel. The fun commands are
documented in the [All Commands page Fun section](/core/all-commands#fun).

{{%children containerstyle="div" style="h2" description="true" %}}
6 changes: 3 additions & 3 deletions content/premium.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ Discord user ID and cannot be transferred.

Patreon is the primary method of acquiring premium slots.

1. Pledge the required minimum amount to unlock a premium slot. For the publicly hosted instance, pledge
[here](https://www.patreon.com/yagpdb).
1. Pledge the required minimum amount to unlock a premium slot. For the publicly hosted instance, pledge on
[botlabs' Patreon](https://www.patreon.com/yagpdb).
2. Link your Patreon account to your Discord account ([details
here](https://support.patreon.com/hc/en-us/articles/212052266-How-do-I-get-my-Discord-Rewards-#h_21f22930-84c5-4950-b6b1-3e83312f66dc)).
3. Wait for up to 5 minutes for YAGPDB to verify your Patreon status.
Expand Down Expand Up @@ -129,7 +129,7 @@ When hosting YAGPDB yourself, you have access to a few methods to source premium
1. Configure your price per premium slot in `premium/patreonpremiumsource/patreonpremiumsource.go > func
CalcSlotsForPledge`.
2. Configure relevant env variables to connect YAGPDB to your Patreon API.
- Generating premium codes with `GeneratePremiumCode` [command](core/all-commands#generatepremiumcode).
- Generating premium codes with [`GeneratePremiumCode` command](core/all-commands#generatepremiumcode).
- Setting the `premium.all_guilds_premium` env variable to true.

### Changing Limits
Expand Down
8 changes: 4 additions & 4 deletions content/reference/custom-command-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ commands.

{{% notice style="note" %}}

This isn't the actual page about custom commands. A brief overview about custom commands can be found
[here](/custom-commands). Please take notice, some of examples presented here are not up to date
with current capabilities of YAGPDB. Please visit our [support server](https://discord.gg/0vYlUK2XBKldPSMY) for newer
solutions.
This isn't the actual page about custom commands. A brief overview about custom commands can be found on the
[Custom Commands documentation](/custom-commands). Please take notice, some of examples presented here are not up to
date with current capabilities of YAGPDB. Please visit our [support server](https://discord.gg/0vYlUK2XBKldPSMY) for
newer solutions.

{{% /notice %}}

Expand Down
7 changes: 4 additions & 3 deletions content/reference/custom-embeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ A guide to creating custom embeds in various contexts across YAGPDB.

{{% notice warning %}}

Embeds have limits, summarized [here](https://discord.com/developers/docs/resources/channel#embed-object-embed-limits).
Embeds have limits, summarized in [Discord channel
documentation](https://discord.com/developers/docs/resources/channel#embed-object-embed-limits).

{{% /notice %}}

Expand Down Expand Up @@ -158,8 +159,8 @@ with our already known definition of the embed. Then I start with the first obje
to join two strings (text snippets) together.\
\
Next, we have the description. We can use markdown of Discord in here. After that object, I define the color. The color
is given as integer and you can convert a hex color to it
[here](https://www.binaryhexconverter.com/hex-to-decimal-converter).
is given as integer and you can convert a hex color to it using
[BinaryHex Converter](https://www.binaryhexconverter.com/hex-to-decimal-converter), for example..

Up next, I have added some fields. This is a bit more difficult, but doable if you have understood it once. Let's break
it down in this example:
Expand Down
28 changes: 14 additions & 14 deletions content/reference/templates/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ All available data that can be used in YAGPDB's templating "engine" which is sli
stdlib text/template package; more in depth and info about actions, pipelines and global functions like `printf, index,
len,`etc > [https://golang.org/pkg/text/template/](https://golang.org/pkg/text/template/) . This section is meant to be
a concise and to the point reference document for all available templates/functions. **Functions** are covered
[here](functions). For detailed explanations and syntax guide refer to the [learning
in [Function documentation](functions). For detailed explanations and syntax guide refer to the [learning
resource](https://learn.yagpdb.xyz/).

**Legend**: at current state this is still prone to formatting errors, but everything in a `code block` should refer to
Expand Down Expand Up @@ -45,8 +45,8 @@ Templating system uses standard ASCII quotation marks:\
0x22 > `"` for straight double quotes, 0x27 > `'`for apostrophes and 0x60 `` ` `` for backticks/back quotes; so make
sure no "smart-quotes" are being used.

The difference between back quotes and double quotes in string literals is covered
[here](https://go.dev/ref/spec#String\_literals).
The difference between back quotes and double quotes in string literals is covered in
[Golang reference documentation](https://go.dev/ref/spec#String\_literals).

{{% /notice %}}

Expand Down Expand Up @@ -126,7 +126,7 @@ Similarly, provided a channel `$channel`, `$channel.Name` gives the name of the
|.IsMessageEdit| Returns boolean true/false if message is edited and edit trigger for custom commands is enabled. Defaults to false.|
|.IsPremium| Returns boolean true/false whether guild is premium of YAGPDB or not.|
|.LinkRegex| Returns string value of in-built link-matching regular expression.|
|.Permissions| Returns all mapped-out permission bits available for Discord in their bitshifted decimal values; <br>e.g. `{{.Permissions.AddReactions}}` would return `64`, same as `{{bitwiseLeftShift 1 6}}`. More [here](https://discord.com/developers/docs/topics/permissions#permissions).|
|.Permissions| Returns all mapped-out permission bits available for Discord in their bitshifted decimal values; <br>e.g. `{{.Permissions.AddReactions}}` would return `64`, same as `{{bitwiseLeftShift 1 6}}`. More in [Discord Permissions documentation](https://discord.com/developers/docs/topics/permissions#permissions).|
|.ServerPrefix| Returns server's command-prefix.|

### Channel
Expand All @@ -146,14 +146,14 @@ Similarly, provided a channel `$channel`, `$channel.Name` gives the name of the
|.Channel.NSFW| Outputs whether this channel is NSFW or not.|
|.Channel.OwnerID| The ID of the creator of threads as _int64_. Returns `0` for normal channels.|
|.Channel.ParentID| The ID of the channel's parent (category), returns 0 if none.|
|.Channel.PermissionOverwrites| A slice of [permission overwrite](https://discord.com/developers/docs/resources/channel#overwrite-object) structures applicable to the channel.|
|.Channel.PermissionOverwrites| A slice of [Discord permission overwrite](https://discord.com/developers/docs/resources/channel#overwrite-object) structures applicable to the channel.|
|.Channel.Position| Channel position from top-down.|
|.Channel.Topic| The topic of the channel.|
|.Channel.Type| The type of the channel. [Explained here.](https://discord.com/developers/docs/resources/channel#channel-object-channel-types)|
|.Channel.Type| The type of the channel. Explained further in [Discord channel documentation](https://discord.com/developers/docs/resources/channel#channel-object-channel-types)|

[Channel object in Discord documentation](https://discordapp.com/developers/docs/resources/channel#channel-object).

Channel functions are covered [here](functions#channel).
[Channel functions documentation](functions#channel).

### Guild / Server

Expand All @@ -167,7 +167,7 @@ Channel functions are covered [here](functions#channel).
|.Guild.Emojis| Outputs a list of emojis in the guild with type _discordgo.Emoji._|
|.Guild.ExplicitContentFilter| Outputs the explicit content [filter level](https://discordapp.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level) for the guild.|
|.Guild.Features| The list of enabled guild features of type _\[]string_.|
|.Guild.Icon| Outputs the [icon hash](https://discordapp.com/developers/docs/reference#image-formatting) ID of the guild's icon. Setting full icon URL is explained [here](https://discord.com/developers/docs/reference#image-formatting).|
|.Guild.Icon| Outputs the [icon hash](https://discordapp.com/developers/docs/reference#image-formatting) ID of the guild's icon. Setting full icon URL is explained in [Discord reference documentation](https://discord.com/developers/docs/reference#image-formatting).|
|.Guild.ID| Outputs the ID of the guild.|
|.Guild.MemberCount| Outputs the number of users on a guild.|
|.Guild.MfaLevel| The required [MFA level](https://discordapp.com/developers/docs/resources/guild#guild-object-mfa-level) for the guild. If enabled, members with moderation powers will be required to have 2-factor authentication enabled in order to exercise moderation powers.|
Expand Down Expand Up @@ -216,7 +216,7 @@ Channel functions are covered [here](functions#channel).

[Member object in Discord documentation](https://discordapp.com/developers/docs/resources/guild#guild-member-object).

Member functions are covered [here](functions#member).
[Member functions documentation](functions#member).

### Message

Expand Down Expand Up @@ -258,7 +258,7 @@ Member functions are covered [here](functions#member).

[Message object in Discord documentation](https://discordapp.com/developers/docs/resources/channel#message-object).

Message functions are covered [here](functions#message).
[Message functions documentation](functions#message).

### Reaction

Expand Down Expand Up @@ -297,7 +297,7 @@ This is available and part of the dot when reaction trigger type is used.

[User object in Discord documentation](https://discordapp.com/developers/docs/resources/user#user-object).

User functions are covered [here](functions#user).
[User functions documentation](functions#user).

## Actions

Expand Down Expand Up @@ -782,9 +782,9 @@ may only be run twice. (50,10 for premium users).

Learning resources covers database [more in-depth](https://learn.yagpdb.xyz/intermediate/custom-command-database).

**Database functions** are covered [here](functions#database).
[Database functions documentation](functions#database).

[Example here](/reference/custom-command-examples#database-example).
[Database example script](/reference/custom-command-examples#database-example).

### DBEntry

Expand Down Expand Up @@ -842,4 +842,4 @@ all applies here > [https://gobyexample.com/time](https://gobyexample.com/time).
|.TimeMinute| Variable of _time.Duration_ type and returns 1 minute > `1m0s`.|
|.TimeSecond| Variable of _time.Duration_ type and returns 1 second > `1s`.|

Time functions are covered [here](functions#time).
[Time functions documentation](functions#time).
Loading

0 comments on commit 9680e19

Please sign in to comment.