Skip to content
This repository was archived by the owner on Aug 10, 2025. It is now read-only.

Commit 3376656

Browse files
committed
Refactor documentation structure and styles; remove obsolete files, add new API and changelog entries, and enhance sidebar configuration
1 parent 3b58985 commit 3376656

16 files changed

Lines changed: 234 additions & 24 deletions

File tree

docs/api/index.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Overview
3+
---
4+
5+
Let's take a look at the API of DisBot.
6+
7+
## DisBot API and Customer API
8+
9+
:::danger Infomation
10+
Customner API is not available yet. Because the Customer Service is currently under development and offline.
11+
:::
12+
13+
## Events API
14+

docs/changelogs/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: DisBot 1.6.0b29s5 HotFix
3+
---
4+
5+
**Changelog**:
6+
- Fixed API ERROR with the encryption
7+
- Added Customer API
8+
- Added and fixed weird Discord Avatar Change bug with the Disbot Image Service (you couldn't change the avatar in the dashboard)
9+
- Fixed more bugs...
10+
- Just a small update and only visible on the Discord (currently) and it continues see our Discord Channels
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
---
22
title: Overview
3-
---
3+
---

docs/customization/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Overview
3+
---

docs/features/autoroles.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Autoroles
3+
---

docs/index.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Overview
3+
---
4+
5+
:::warning Docs in Progress
6+
The Docs are not done and some things are missing! [Contribute on GitHub](https://github.com/DisBotDevelopment/DisBot-Docs)
7+
:::
8+
9+
## Introduction
10+
11+
DisBot is a powerful Discord bot designed to enhance your server's functionality and user experience. With a wide range of features, including moderation tools, fun commands, and utility functions, DisBot is the perfect companion for any Discord community.
12+
It is built with TypeScript and is designed to be modular, allowing for easy customization and extension.
13+
14+
## Features
15+
16+
- **Autopuplish**: Automatically publish you messages in a channel to another channel.
17+
- **Autoreact**: Automatically react to messages in a channel with a specific emoji.
18+
- **AutoRole**: Automatically assign roles to new members when they join your server.
19+
- **Tickets**: Create and manage support tickets for your server members. (Advanced)
20+
- **Moderation**: Kick, ban, mute, and manage members in your server with ease.
21+
- **TempVC**: Create temporary voice channels for your server members.
22+
- **Notifications**: Send notifications to your server members about important events or updates. (Youtube, Twitch, etc.)
23+
- **Message Templates**: Create and manage message templates for your server members.
24+
- **Tag System**: Create and manage tags for your server members. (With custom Commands and Chat Commands (!tag))
25+
- **Information**: Get information about your server members, channels, and roles.
26+
- **Welcome**: Send welcome messages to new members when they join your server.
27+
- **Leave**: Send leave messages to members when they leave your server.
28+
- **Logging**: Log important events in your server, such as member joins, leaves, and bans.
29+
30+
## Placeholders
31+
32+
- Take a look at the [Placeholders](placeholders) page to see all available placeholders.
33+
- Placeholders are used to replace certain values in messages, such as user IDs, usernames, and server names.
34+
35+
## API Reference
36+
37+
- Take a look at the [API Reference](api) page to see all available API methods and events.
38+
- Events API is used to listen to events in your server, such as member joins, leaves, and bans.
39+
40+
## Contact Us
41+
42+
- For Contact use our Form at https://nexocrew.com/contact or join our [Discord Server](https://disbot.xyz/discord) for support and feedback.

docs/quick-start.md

Whitespace-only changes.

docs/quick-start.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Quick Start
3+
---

generate-sidebar-css.js

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import fs from "fs";
2+
import path from "path";
3+
4+
const styles = ["sparkles", "booktext", "webhook", "route"];
5+
6+
const output = [];
7+
8+
for (const style of styles) {
9+
const className = "style_" + style.replace(/\//g, "_");
10+
const iconPath = `../../static/img/sidebar/${style}.png`;
11+
12+
output.push(`
13+
.${className} .menu__link {
14+
position: relative;
15+
padding-left: 2em;
16+
}
17+
.${className} .menu__link::before {
18+
content: "";
19+
position: absolute;
20+
top: 50%;
21+
left: 1%;
22+
transform: translateY(-50%);
23+
width: 1em;
24+
height: 1em;
25+
background-image: url("${iconPath}");
26+
background-size: contain;
27+
background-repeat: no-repeat;
28+
}
29+
`);
30+
}
31+
32+
fs.writeFileSync(path.join("./src/css/sidebar-style.css"), output.join("\n"));
33+
console.log("✅ sidebar-style.css wurde generiert!");

sidebars.ts

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,51 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
1414
*/
1515
const sidebars: SidebarsConfig = {
1616
// By default, Docusaurus generates a sidebar from the docs folder structure
17-
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
17+
//tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
1818

1919
// But you can create a sidebar manually
20-
/*
20+
2121
tutorialSidebar: [
22-
'intro',
23-
'hello',
22+
'index',
23+
'quick-start',
24+
{
25+
type: 'category',
26+
label: 'Features',
27+
items: ['features/autoroles'],
28+
},
29+
{
30+
type: 'category',
31+
label: 'API Reference',
32+
items: [{
33+
type: "doc",
34+
id: "api/index",
35+
label: "Overview",
36+
className: "style_booktext"
37+
}],
38+
className: "style_route"
39+
},
40+
{
41+
type: 'category',
42+
label: 'Customization',
43+
items: [{
44+
type: "doc",
45+
id: "customization/index",
46+
label: "Introduction",
47+
className: "style_booktext"
48+
}],
49+
className: "style_sparkles"
50+
},
51+
{
52+
type: 'category',
53+
label: 'Customer',
54+
items: ['customer/index'],
55+
},
2456
{
2557
type: 'category',
26-
label: 'Tutorial',
27-
items: ['tutorial-basics/create-a-document'],
58+
label: 'Changelogs',
59+
items: ['changelogs/index'],
2860
},
29-
],
30-
*/
61+
]
3162
};
3263

3364
export default sidebars;

0 commit comments

Comments
 (0)