Skip to content

Commit

Permalink
Merge pull request #42 from igdiaysu/content-13
Browse files Browse the repository at this point in the history 
feat: adding and updating contents, and sidebare structure
  • Loading branch information
@igdiaysu
igdiaysu authored Feb 18, 2024
2 parents 45610fc + a08a964 commit 8d1015c
Show file tree
Hide file tree
Showing 16 changed files with 922 additions and 333 deletions.
33 changes: 18 additions & 15 deletions docs/.vitepress/config.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export default defineConfig({
// { text: "Getting Started", link: "/getting-started" },
// ],
// },
// Twitch
// Twitch - EN
{
text: 'Twitch',
collapsed: false,
Expand Down Expand Up @@ -201,7 +201,7 @@ export default defineConfig({
}
]
},
// Discord
// Discord - EN
{
text: 'Discord',
collapsed: false,
Expand All @@ -211,7 +211,10 @@ export default defineConfig({
link: '/discord-bot/getting-started'
},
{ text: 'Commands', link: '/discord-bot/commands' },
// { text: "Custom Commands", link: "/discord-bot/custom-commands" },
{
text: 'Custom Commands',
link: '/discord-bot/custom-commands'
},
{
text: 'Modules',
collapsed: true,
Expand All @@ -223,12 +226,12 @@ export default defineConfig({
{
text: 'Live Stream Events',
link: '/discord-bot/live-stream-events'
},
{
text: 'Custom API System',
link: '/discord-bot/custom-api-system'
}
// {
// text: "Custom API System",
// link: "/discord-bot/custom-api-system",
// },
// {
// text: "Reminder System",
// link: "/discord-bot/reminder-system",
// },
Expand Down Expand Up @@ -332,10 +335,10 @@ export default defineConfig({
link: '/tr/discord-bot/getting-started'
},
{ text: 'Komutlar', link: '/tr/discord-bot/commands' },
// {
// text: "Özel Komutlar",
// link: "/tr/discord-bot/custom-commands",
// },
{
text: 'Özel Komutlar',
link: '/tr/discord-bot/custom-commands'
},
{
text: 'Modüller',
collapsed: true,
Expand All @@ -347,12 +350,12 @@ export default defineConfig({
{
text: 'Canlı Yayın Etkinlikleri',
link: '/tr/discord-bot/live-stream-events'
},
{
text: 'Custom API Sistemi',
link: '/tr/discord-bot/custom-api-system'
}
// {
// text: "Custom API Sistemi",
// link: "/tr/discord-bot/custom-api-system",
// },
// {
// text: "Hatırlatıcı Sistemi",
// link: "/tr/discord-bot/reminder-system",
// },
Expand Down
27 changes: 25 additions & 2 deletions docs/MARKDOWN-EXTENSIONS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@ We have custom button style
</a>
</div>

## Discord
### Discord Application Commands Style

We use a special component for Discord application commands.
Expand Down Expand Up @@ -333,7 +334,7 @@ You can also use it with two options:
>
</ApplicationCommands>

## Displaying Discord messages
### Displaying Discord messages

We use [@discord-message-components/vue](https://github.com/Danktuary/discord-message-components/blob/main/packages/vue/README.md) to display "fake" Discord messages on pages. The reason for this is to make it easy for you to create, easy for anyone in the future to edit, and avoid having to take screenshots and using too many images on a page at once. Here's a preview of the components:

Expand All @@ -358,8 +359,30 @@ The syntax to make this display is quite simple as well:
</DiscordMessage>
</DiscordMessages>
```
#### Custom Command Messages

### Slash Command messages
**Input**
```js
<DiscordMessages>
<DiscordMessage profile="user">
!ping
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
pong! Took 50ms
</DiscordMessage>
</DiscordMessages>
```
**Output**
<DiscordMessages>
<DiscordMessage profile="user">
!ping
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
pong! Took 50ms
</DiscordMessage>
</DiscordMessages>

#### Slash Command messages

**`ephemeral` Version**

Expand Down
8 changes: 4 additions & 4 deletions docs/discord-bot/commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| senchabot | An open-source, multi-platform bot designed for seamless integration with Twitch and Discord • [senchabot.app](https://senchabot.app) • [github.com/senchabot-opensource/monorepo](https://github.com/senchabot-opensource/monorepo) |
| kampus | discord.gg/kampus - github.com/kamp-us |
| frontendship | discord.gg/frontendship |
| ping | pong! VoHiYo |
| ping | pong! VoHiYo

<!-- PURGE -->
<!-- ## Purge <Badge type="info" text="planned"/>
Expand Down Expand Up @@ -54,9 +54,9 @@
<!-- Custom API System - CONTENT REFERANCE SMALL -->
<style src="@theme/style.css" scoped></style>
<div>
<a class="content-ref-s" href="">
<a class="content-ref-s" href="/discord-bot/custom-api-system">
<span class="ref-details-s">
<span class="content-ref-page-title-s">Custom API System <Badge type="danger" text="planned | not active" /></span>
<span class="content-ref-page-title-s">Custom API System <Badge type="warning" text="NEW"/></span>
</span>
<svg style="width:32px;height:32px;" viewBox="0 0 24 24" class="content-ref-svg-s" aria-hidden="true"><path fill="currentColor" d="M4,11V13H16L10.5,18.5L11.92,19.92L19.84,12L11.92,4.08L10.5,5.5L16,11H4Z"></path></svg>
</a>
Expand All @@ -76,5 +76,5 @@
<br/>

::: info Cooldown System
Command usage cooldown time is 2 minutes per user.
Command usage cooldown time is 2 seconds per user.
:::
97 changes: 96 additions & 1 deletion docs/discord-bot/custom-api-system.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,96 @@
# Custom API System <Badge type="danger" text="planned | not active" />
---
outline: [2, 3]
---

# Custom API System <Badge type="warning" text="NEW"/>

This system allows you to send a GET request to a URL through the specified template and receive a response through a custom command you have added to your channel.

```
{customapi.https://...}
```

#### Adding Commands to Your Server

```
!acmd [command_name] [command_content {customapi.https://...}]
```

## What You Can Do with Custom API

### Display the Currently Playing Song on Spotify <Badge type="warning" text="NEW"/>

<!-- AidenWallis - CONTENT REFERANCE LARGE -->
<style src="@theme/style.css" scoped></style>
<div>
<a class="content-ref" href="https://spotify.aidenwallis.co.uk/" target="blank_">
<span class="ref-details">
<span class="content-ref-section-title">AIDEN WALLIS</span>
<span class="content-ref-page-title">Connect Your Spotify</span>
</span>
<svg style="width:48px;height:48px;" viewBox="0 0 24 24" class="content-ref-svg" aria-hidden="true"><path fill="currentColor" d="M4,11V13H16L10.5,18.5L11.92,19.92L19.84,12L11.92,4.08L10.5,5.5L16,11H4Z"></path></svg>
</a>
</div>

```
{customapi.https://spotify.aidenwallis.co.uk/u/...}
```

::: info Example Command Add
<!-- EXAMPLE - Custom Commands -->
<DiscordMessages>
<DiscordMessage profile="user">
!acmd song Currently Playing: {customapi.https://spotify.aidenwallis.co.uk/u/...}
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
New Command Added: song
</DiscordMessage>
</DiscordMessages>
:::

::: details Example Usage
<!-- EXAMPLE - Custom Commands -->
<DiscordMessages>
<DiscordMessage profile="user">
!song
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
Currently Playing: ANGELPLAYA - DANGEROUS
</DiscordMessage>
</DiscordMessages>
:::

::: info Adding Spotify Widget to Your Stream

Use the link in the format `https://nowplaying.aidenwallis.co.uk/...` under the title "_Now Playing Widget_" on Aiden Wallis' website as a _browser source_ in your streaming software (OBS Studio, Streamlabs...).

:::

### Generate Random Text <Badge type="warning" text="NEW"/>

```
{customapi.https://techy-api.vercel.app/api/text}
```
::: info Example Command Add
<!-- EXAMPLE - Custom Commands -->
<DiscordMessages>
<DiscordMessage profile="user">
!acmd text {customapi.https://techy-api.vercel.app/api/text}
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
New Command Added: text
</DiscordMessage>
</DiscordMessages>
:::

::: details Example Usage
<!-- EXAMPLE - Custom Commands -->
<DiscordMessages>
<DiscordMessage profile="user">
!text
</DiscordMessage>
<DiscordMessage profile="bot" role-color="#1fab89" >
The hardest part was setting the traffic velocity
</DiscordMessage>
</DiscordMessages>
:::
Loading

0 comments on commit 8d1015c

Please sign in to comment.