Merge branch 'main' into beta

Author: NervN

DockerfileDev

@@ -0,0 +1,10 @@
+# Stage 1 — build the static assets
+FROM node:20-alpine3.21 AS builder
+WORKDIR /app
+
+COPY package*.json ./
+RUN npm ci
+
+COPY . .
+
+CMD ["npm", "run", "dev"]

README.md

@@ -1,12 +1,60 @@
-# ccdoc
-Custom Command Documentation
+# Getting Started with Custom Command Bot
 
-# How to contribute?
-You can contribute by forking this repo, [click here](https://github.com/raspdevpy/ccdoc/fork), modify the changes, then Pull request.
+:::tip Important: Read This First!
+To get the most out of Custom Command Bot and avoid confusion, we highly recommend reading this guide in its entirety. Understanding the concepts presented here will make creating and managing custom commands much easier.
+:::
 
-# How to run?
+## What is Custom Command Bot?
+
+Custom Command Bot empowers you to create fully customizable commands for your Discord server. It's a versatile tool suitable for both experienced developers and beginners who want a simple and effective way to enhance their server's functionality.
+
+### How Do Custom Commands Work?
+
+As the name suggests, custom commands are entirely customizable! You have the flexibility to define almost any action that a Discord bot can perform, tailored to your specific needs.
+
+### Do I Need Coding Experience?
+
+No coding experience is required! Custom Command Bot uses an easy-to-learn pseudo-language designed specifically for straightforward Discord bot development.
+
+## Inviting the Bot to Your Server
+
+Adding Custom Command Bot to your server is a breeze. Just follow these simple steps:
+
+1.  **Invite the Bot:** Click [this link](https://discord.com/api/oauth2/authorize?client_id=725721249652670555&permissions=268561655&scope=bot) to invite the bot to your server.
+
+    > ![](https://i.imgur.com/NQp3N8L.png)
+
+    :::details Permissions
+    We recommend keeping all the preset permissions during the invitation process. This will prevent future issues caused by the bot lacking necessary permissions. If you have security concerns, please refer to our Privacy Policy accessible via [this link](https://doc.ccommandbot.com/Guide/policy.html).
+    > ![](https://i.imgur.com/7WnDcnG.png)
+    :::
+
+2.  **Log in to the Dashboard:** Go to the [Dashboard](https://ccommandbot.com) and log in.
+
+    > ![](https://i.imgur.com/pvJ3i6R.png)
+
+3.  **Select Your Server:** Choose the server you want to manage from the dashboard.
+
+    > ![](https://i.imgur.com/XxSsZ4G.png)
+
+## Creating Your First Custom Commands
+
+With the bot successfully added to your server, you're now ready to unleash your creativity and build your own custom commands!
+
+Head over to [the full guide](../Guide/1.create.md) to learn how to create your first command.
+
+# How to run 
+
+## Without Docker
 Required: Node 18.x, npm
 
 1. run `git clone https://github.com/raspdevpy/ccdoc`
 2. run `npm install`
 3. run `npm run dev`, and head to `https://localhost:8080`
+
+## With Docker
+If docker and docker compose is installed in your system
+
+1. run `git clone https://github.com/raspdevpy/ccdoc`
+2. run `docker compose up`
+3. head to `https://localhost:8080`

docker-compose.yml

@@ -0,0 +1,13 @@
+services:
+  ccdoc-dev:
+    build:
+      context: .
+      dockerfile: DockerfileDev
+    volumes:
+      - .:/app
+      - /app/node_modules
+    ports:
+      - 8080:8080
+    command: npm run dev
+volumes:
+  redis_data:

guide/.vuepress/config.js

@@ -1,6 +1,7 @@
 const sidebar = require('./sidebar');
 const parseTag = require('./parseTags');
 const replacements = require('./replacements');
+const fs = require('fs')
 const replacePageContent = (content, replacements) => {
 	let output = content;
 	for (const [placeholder, replacement] of Object.entries(replacements)) {
@@ -11,10 +12,23 @@ const replacePageContent = (content, replacements) => {
   };
 module.exports = {
 	lang: 'en-US',
-	title: 'Custom Command Bot',
-	description: 'The documentation of Custom Command bot',
+	title: 'Custom Command',
+	description: 'Custom Command Bot\'s Documentation',
 	theme: '@vuepress/default',
-	head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
+	head: [
+		['link', { rel: 'icon', href: 'https://doc.ccommandbot.com/bot-profile.png' }],
+		['meta', { name: 'theme-color', content: '#74b0f7' }],
+
+		['meta', { property: 'og:title', content: 'Custom Command Bot' }],
+		['meta', { property: 'og:description', content: 'Custom Command Bot\'s Documentation' }],
+		['meta', { property: 'og:image', content: 'https://doc.ccommandbot.com/bot-profile.png' }],
+		['meta', { property: 'og:url', content: 'https://ccommandbot.com' }],
+
+
+		['meta', { name: 'twitter:title', content: 'Custom Command Bot' }],
+		['meta', { name: 'twitter:description', content: 'Custom Command Bot\'s Documentation' }],
+		['meta', { name: 'twitter:image', content: 'https://doc.ccommandbot.com/bot-profile.png' }]
+	],
 	//plugins: ['@vuepress/plugin-container'],
 	plugins: [
 		(options, context) => ({
@@ -31,6 +45,14 @@ module.exports = {
 		  }),
 		['@vuepress/plugin-search',{
 			maxSuggestions:15,
+			isSearchable:(page)=>{
+				if(!page.data.filePathRelative)	return true;
+				if(page.data.filePathRelative.endsWith('_ai.md'))
+					return true;
+				let aiFile = __dirname+'/../'+page.data.filePathRelative.replace('.md','_ai.md');
+				if(fs.existsSync(aiFile))	return false;
+				return true;
+			},
 			getExtraFields: (page) =>parseTag(page),
 		}],
 		['@vuepress/plugin-container'],
@@ -53,7 +75,7 @@ module.exports = {
 		repo: 'raspdevpy/ccdoc',
 		contributors:false,
 		search: true,
-		logo: 'https://cdn.discordapp.com/icons/832255686783533066/f7131f694c6e1a2bd9c360d8b525d4e3.webp',
+		logo: '/favicon.ico',
 		editLinks: true,
 		editLinkText: 'Improve This Page!',
 		lastUpdated: true,

guide/.vuepress/public/bot-profile.png

@@ -12,12 +12,17 @@ function getSideBar(folder, title, options={}) {
 				fs.statSync(path.join(`${__dirname}/../${folder}`, item)).isFile() &&
 				extension.includes(path.extname(item))
 		);
-    for (let i = 0; i < files.length; i++) {
-		let name = files[i]
-		//-files[i]={text:name,link:`/${folder}/${name}`}
-		files[i]=`/${folder}/${name}`
-	}
-	return { text: title, children: files, collapsible:false,...options};
+	let aiRefinedFiles = files.filter(file=>file.endsWith('_ai.md'));
+	
+	let children = [];
+	files.forEach(name=>{
+		if(name.endsWith('_ai.md'))	return;
+		if(aiRefinedFiles.includes(name.replace('.md', '_ai.md')))
+			children.push(`/${folder}/${name.replace('.md', '_ai.md')}`)
+		else
+			children.push(`/${folder}/${name}`)
+	})
+	return { text: title, children, collapsible:false,...options};
 
 
 }
@@ -73,7 +78,7 @@ module.exports= {
 			getSideBar('Cooldown','Cooldown functions',{collapsible:true}),
 			getSideBar('Request','Http Requests functions',{collapsible:true}),
 			getSideBar('Image','Image Builder functions',{collapsible:true}),
-			getSideBar('Unclassified','Unclassfied Functions',{collapsible:true})
+			// getSideBar('Unclassified','Unclassfied Functions',{collapsible:true})
 		]
 	},		
 		getSideBar('Contribution_Info','Contribute'),

guide/.vuepress/public/fonts/Assistant-Medium.ttf

@@ -0,0 +1,34 @@
+@font-face {
+    font-family: 'Assistant-Medium';
+    src: url('/fonts/Assistant-Medium.ttf') format('truetype');
+    font-style: normal;
+    font-weight: normal;
+}
+@font-face {
+    font-family: 'Noto-Sans-Medium';
+    src: url('/fonts/NotoSans-Medium.ttf') format('truetype');
+    font-style: normal;
+    font-weight: normal;
+}
+.discord-messages {
+    background-color: #202024 !important;
+    border: 1px solid #3f4245 !important;
+}
+.discord-messages,
+.discord-messages * {
+    font-family: 'Assistant-Medium', sans-serif !important;
+}
+.discord-message .discord-author-info .discord-author-username {
+    font-family: 'Noto-Sans-Medium', sans-serif !important;
+    font-size: 0.95rem !important;
+    letter-spacing: 0px !important;
+    display: inline-flex !important;
+}
+.discord-message .discord-message-body {
+    font-size: 15px !important;
+}
+.discord-message .discord-message-content .discord-message-timestamp {
+    display: inline-flex !important;
+    font-size: 11px !important;
+    margin-left: 5px !important;
+}

guide/.vuepress/public/fonts/NotoSans-Medium.ttf

@@ -1,8 +1,17 @@
 # $botCount
-Returns the amount of bots in your server/guild!
+
+This function returns the total number of bots present in your Discord server (guild).
 
 #### Usage: `$botCount`
-<br/>
+
+Here's how you can use the `$botCount` function:
+
+```
+!!exec There are `$botCount` bots in the server!
+```
+
+This command, when executed, will display a message showing the bot count in the server.  See the example below:
+
 <discord-messages>
 	<discord-message :bot="false" role-color="#ffcc9a" author="Member">
 		!!exec There are `$botCount` bots in the server!
@@ -12,5 +21,10 @@ Returns the amount of bots in your server/guild!
 	</discord-message>
 </discord-messages>
 
-##### Function Difficulty: <Badge type="tip" text="Easy" vertical="middle" /> 
-###### Tags: <Badge type="tip" text="bots" vertical="middle" /> <Badge type="tip" text="count" vertical="middle" /> <Badge type="tip" text="amount of bots" vertical="middle" /> <Badge type="tip" text="return number" vertical="middle" />
+::: danger Warning
+The bot count is retrieved from the bot's cache, not directly from the Discord API. This means the count might not be perfectly accurate, especially if all server members haven't been fully cached.  Full caching is typically achieved at higher bot tiers (Tier 5).
+:::
+
+##### Function Difficulty: <Badge type="tip" text="Easy" vertical="middle" />
+
+###### Tags: <Badge type="tip" text="bots" vertical="middle" /> <Badge type="tip" text="count" vertical="middle" /> <Badge type="tip" text="amount of bots" vertical="middle" /> <Badge type="tip" text="return number" vertical="middle" />