Skip to content

Commit

Permalink
refactor: move docs to starlight
Browse files Browse the repository at this point in the history
  • Loading branch information
ghostdevv committed Nov 8, 2024
1 parent a83dc0a commit e7f0442
Show file tree
Hide file tree
Showing 36 changed files with 4,983 additions and 641 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ node_modules
.env
dist
.jellycommands
packages/docs/.vitepress/cache
coverage
.astro/
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ node_modules
.env
dist
.jellycommands
.vitepress/cache
.changeset/*.md
.changeset/pre.json
pnpm-lock.yaml
.astro/
6 changes: 5 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
{
"recommendations": ["esbenp.prettier-vscode", "biomejs.biome"]
"recommendations": [
"esbenp.prettier-vscode",
"biomejs.biome",
"astro-build.astro-vscode"
]
}
7 changes: 0 additions & 7 deletions packages/docs/api/index.md

This file was deleted.

161 changes: 161 additions & 0 deletions packages/docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
// @ts-check
import starlightLinksValidator from 'starlight-links-validator';
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
site: 'https://jellycommands.dev',

output: 'static',
trailingSlash: 'never',

integrations: [
starlight({
title: 'JellyCommands',
description:
'Jellycommands is a developer experience focused command framework for discord.js. It has support for all types of application commands, including slash commands and conlabel menus. It also includes quality of life features such as caching and developer mode.',
social: {
github: 'https://github.com/ghostdevv/jellycommands',
},
favicon: '/logo.svg',
customCss: ['./src/theme.css'],
editLink: {
baseUrl:
'https://github.com/ghostdevv/jellycommands/edit/main/packages/docs/',
},
lastUpdated: true,
sidebar: [
{
label: 'Guide',
items: [
{
label: 'Get Started',
items: [
{
label: 'Overview',
link: '/guide/overview',
},
{
label: 'Import vs Require',
link: '/guide/require',
},
],
},
{
label: 'Commands',
items: [
{
label: 'Creating Commands',
link: '/guide/commands/files',
},
{
label: 'Registering Commands',
link: '/guide/commands/registering',
},
{
label: 'Dev Mode',
link: '/guide/commands/dev',
},
{
label: 'Slash Commands Extras',
link: '/guide/commands/slash',
},
{
label: 'Guards',
link: '/guide/commands/guards',
},
],
},
{
label: 'Events',
items: [
{
label: 'Creating Events',
link: '/guide/events/files',
},
],
},
{
label: 'Buttons',
items: [
{
label: 'Creating Buttons',
link: '/guide/buttons/files',
},
],
},
{
label: 'Core',
items: [
{
label: 'Components',
link: '/guide/components',
},
{
label: 'Props',
link: '/guide/props',
},
{
label: 'Messages',
link: '/guide/messages',
},
],
},
{
label: 'Migrate',
items: [
{
label: 'Components (1.0.0-next.44)',
link: '/guide/migrate/components',
},
{
label: 'Props (1.0.0-next.40)',
link: '/guide/migrate/props',
},
{
label: 'Discord.js v14 (1.0.0-next.31)',
link: '/guide/migrate/djs14',
},
],
},
],
},
{
label: 'API',
items: [
{
label: 'Core',
items: [
{
label: 'Client',
link: '/api/client',
},
{
label: 'Props',
link: '/api/props',
},
{
label: 'Commands',
link: '/api/commands',
},
{
label: 'Events',
link: '/api/events',
},
{
label: 'Buttons',
link: '/api/buttons',
},
{
label: 'App Types',
link: '/api/types',
},
],
},
],
},
],
}),
],
});
42 changes: 0 additions & 42 deletions packages/docs/index.md

This file was deleted.

14 changes: 11 additions & 3 deletions packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
"name": "@jellycommands/docs",
"private": true,
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build"
"dev": "astro dev",
"build": "astro build",
"lint": "astro check"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.28.6",
"astro": "^4.15.3",
"sharp": "^0.32.5",
"typescript": "^5.6.3"
},
"packageManager": "[email protected]",
"engines": {
Expand All @@ -16,6 +24,6 @@
"pnpm": "9.12.3"
},
"devDependencies": {
"vitepress": "1.1.4"
"starlight-links-validator": "^0.13.0"
}
}
41 changes: 29 additions & 12 deletions packages/docs/public/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions packages/docs/src/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions packages/docs/src/content/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { defineCollection } from 'astro:content';
import { docsSchema } from '@astrojs/starlight/schema';

export const collections = {
docs: defineCollection({ schema: docsSchema() }),
};
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Buttons
---
title: Buttons
---

## Loading

Expand Down Expand Up @@ -51,6 +53,6 @@ Should the interaction be defered

When true JellyCommands will ignore this button.

:::tip NOTE
:::note
When using file-loaded commands, you can get the same behavior by adding an `_` in front of the file.
:::
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Client
---
title: Client
---

The `JellyCommands` client is the core of every project. It extends the [discord.js client](https://discord.js.org/#/docs/discord.js/main/class/Client) to add additional functionality.

Expand Down
Loading

0 comments on commit e7f0442

Please sign in to comment.