setup docs

notunderctrl · notunderctrl · commit ae88ce147c0a · 2023-09-21T11:13:46.000+03:00
diff --git a/apps/nextra-docs/pages/_app.tsx b/apps/nextra-docs/pages/_app.tsx
diff --git a/apps/nextra-docs/pages/_document.tsx b/apps/nextra-docs/pages/_document.tsx
diff --git a/apps/nextra-docs/pages/_meta.json b/apps/nextra-docs/pages/_meta.json
@@ -0,0 +1,14 @@
+{
+    "index": {
+        "title": "Home",
+        "type": "page"
+    },
+    "guides": {
+        "title": "Guides",
+        "type": "page"
+    },
+    "docs": {
+        "title": "Documentation",
+        "type": "page"
+    }
+}
diff --git a/apps/nextra-docs/pages/docs/_meta.json b/apps/nextra-docs/pages/docs/_meta.json
@@ -0,0 +1,6 @@
+{
+    "classes": "Classes",
+    "functions": "Functions",
+    "typedef": "Type Definitions",
+    "enums": "Enums"
+}
diff --git a/apps/nextra-docs/pages/docs/classes/CommandKit.mdx b/apps/nextra-docs/pages/docs/classes/CommandKit.mdx
diff --git a/apps/nextra-docs/pages/docs/enums/CommandType.mdx b/apps/nextra-docs/pages/docs/enums/CommandType.mdx
@@ -0,0 +1 @@
+# CommandType
diff --git a/apps/nextra-docs/pages/docs/enums/_meta.json b/apps/nextra-docs/pages/docs/enums/_meta.json
@@ -0,0 +1,3 @@
+{
+    "CommandType": "CommandType"
+}
diff --git a/apps/nextra-docs/pages/docs/typedef/CommandData.mdx b/apps/nextra-docs/pages/docs/typedef/CommandData.mdx
@@ -0,0 +1 @@
+# CommandData
diff --git a/apps/nextra-docs/pages/docs/typedef/CommandOptions.mdx b/apps/nextra-docs/pages/docs/typedef/CommandOptions.mdx
@@ -0,0 +1 @@
+# CommandOptions
diff --git a/apps/nextra-docs/pages/docs/typedef/SlashCommandProps.mdx b/apps/nextra-docs/pages/docs/typedef/SlashCommandProps.mdx
@@ -0,0 +1 @@
+# SlashCommandProps
diff --git a/apps/nextra-docs/pages/docs/typedef/_meta.json b/apps/nextra-docs/pages/docs/typedef/_meta.json
@@ -0,0 +1,5 @@
+{
+    "CommandData": "CommandData",
+    "CommandOptions": "CommandOptions",
+    "SlashCommandProps": "SlashCommandProps"
+}
diff --git a/apps/nextra-docs/pages/guides/commandkit-setup.mdx b/apps/nextra-docs/pages/guides/commandkit-setup.mdx
@@ -1 +1,101 @@
+import { Steps, Tabs, Callout } from 'nextra/components';
+
 # CommandKit Setup
+
+This is a simple overview of how to set up CommandKit with all the available options. You’d usually set this up in your entry point file (e.g. `index.js`) where you have access to your Discord client object.
+
+<Tabs items={['CommonJS', 'ESM', 'TypeScript']}>
+    <Tabs.Tab>
+        ```js filename="index.js" copy {2, 13-22}
+        const { Client, GatewayIntentBits } = require('discord.js');
+        const { CommandKit } = require('commandkit');
+        const path = require('path');
+
+        const client = new Client({
+            intents: [
+                GatewayIntentBits.Guilds,
+                GatewayIntentBits.GuildMessages,
+                GatewayIntentBits.MessageContent,
+            ],
+        });
+
+        new CommandKit({
+            client,
+            commandsPath: path.join(__dirname, 'commands'),
+            eventsPath: path.join(__dirname, 'events'),
+            validationsPath: path.join(__dirname, 'validations'),
+            devGuildIds: ['DEV_SERVER_ID_1', 'DEV_SERVER_ID_2'],
+            devUserIds: ['DEV_USER_ID_1', 'DEV_USER_ID_2'],
+            devRoleIds: ['DEV_ROLE_ID_1', 'DEV_ROLE_ID_2'],
+            skipBuiltInValidations: true,
+        });
+
+        client.login('YOUR_TOKEN_HERE');
+
+        ```
+    </Tabs.Tab>
+    <Tabs.Tab>
+        ```js filename="index.js" copy {2, 16-25}
+        import { Client, GatewayIntentBits } from 'discord.js';
+        import { CommandKit } from 'commandkit';
+        import { fileURLToPath } from 'url';
+        import path from 'path';
+
+        const client = new Client({
+            intents: [
+                GatewayIntentBits.Guilds,
+                GatewayIntentBits.GuildMessages,
+                GatewayIntentBits.MessageContent
+            ],
+        });
+
+        const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+        new CommandKit({
+            client,
+            commandsPath: path.join(__dirname, 'commands'),
+            eventsPath: path.join(__dirname, 'events'),
+            validationsPath: path.join(__dirname, 'validations'),
+            devGuildIds: ['DEV_SERVER_ID_1', 'DEV_SERVER_ID_2'],
+            devUserIds: ['DEV_USER_ID_1', 'DEV_USER_ID_2'],
+            devRoleIds: ['DEV_ROLE_ID_1', 'DEV_ROLE_ID_2'],
+            skipBuiltInValidations: true,
+        });
+
+        client.login('YOUR_TOKEN_HERE');
+        ```
+    </Tabs.Tab>
+    <Tabs.Tab>
+        ```ts filename="index.ts" copy {2, 13-22}
+        import { Client, GatewayIntentBits } from 'discord.js';
+        import { CommandKit } from 'commandkit';
+        import path from 'path';
+
+        const client = new Client({
+            intents: [
+                GatewayIntentBits.Guilds,
+                GatewayIntentBits.GuildMessages,
+                GatewayIntentBits.MessageContent
+            ],
+        });
+
+        new CommandKit({
+            client,
+            commandsPath: path.join(__dirname, 'commands'),
+            eventsPath: path.join(__dirname, 'events'),
+            validationsPath: path.join(__dirname, 'validations'),
+            devGuildIds: ['DEV_SERVER_ID_1', 'DEV_SERVER_ID_2'],
+            devUserIds: ['DEV_USER_ID_1', 'DEV_USER_ID_2'],
+            devRoleIds: ['DEV_ROLE_ID_1', 'DEV_ROLE_ID_2'],
+            skipBuiltInValidations: true,
+        });
+
+        client.login('YOUR_TOKEN_HERE');
+        ```
+    </Tabs.Tab>
+
+</Tabs>
+
+<Callout>
+    **Note:** Some Discord.js properties are only accessible using the correct intents.
+</Callout>
diff --git a/apps/nextra-docs/pages/guides/installation.mdx b/apps/nextra-docs/pages/guides/installation.mdx
@@ -1,3 +1,9 @@
-# Guides
+import { Callout, Card, Cards, Steps } from 'nextra/components';
 
-Welcome to the Command Kit guide
+# Installation
+
+Installing CommandKit is really simple. Based on your preferred package manager, run one of the commands in your terminal:
+
+```sh npm2yarn
+npm install commandkit
+```
diff --git a/apps/nextra-docs/pages/index.mdx b/apps/nextra-docs/pages/index.mdx
@@ -0,0 +1 @@
+# Home page
diff --git a/apps/nextra-docs/pages/index.tsx b/apps/nextra-docs/pages/index.tsx
diff --git a/apps/nextra-docs/tailwind.config.ts b/apps/nextra-docs/tailwind.config.ts
@@ -2,9 +2,10 @@ import type { Config } from 'tailwindcss';
 
 const config: Config = {
     content: [
-        './pages/**/*.{js,ts,jsx,tsx,mdx}',
-        './components/**/*.{js,ts,jsx,tsx,mdx}',
-        './app/**/*.{js,ts,jsx,tsx,mdx}',
+        './pages/**/*.{js,ts,jsx,tsx,md,mdx}',
+        './components/**/*.{js,ts,jsx,tsx,md,mdx}',
+        './app/**/*.{js,ts,jsx,tsx,md,mdx}',
+        './theme.config.tsx',
     ],
     theme: {
         extend: {},
diff --git a/apps/nextra-docs/theme.config.tsx b/apps/nextra-docs/theme.config.tsx
@@ -1,5 +1,5 @@
 export default {
-    logo: <span>My Nextra Documentation</span>,
+    logo: <span>CommandKit</span>,
     project: {
         link: 'https://github.com/underctrl-io/commandkit',
     },

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "CommandType": "CommandType"`
	`3`	`+}`