Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paradoxuum authored Jul 8, 2024
1 parent 9975825 commit 851ea4d
Show file tree
Hide file tree
Showing 39 changed files with 1,705 additions and 813 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<a href="https://commander.paradoxum.dev/" target="_blank">
<a href="https://centurion.paradoxum.dev/" target="_blank">
<img src="docs/src/assets/logo.webp" width="150" />
</a>

Expand All @@ -17,10 +17,10 @@
[npm-latest-url]: https://www.npmjs.com/package/@rbxts/commander/v/latest
[npm-next-badge]: https://img.shields.io/npm/v/%40rbxts%2Fcommander%2Fnext?logo=npm&label=next
[npm-next-url]: https://www.npmjs.com/package/@rbxts/commander/v/next
[ci-badge]: https://github.com/paradoxuum/commander/actions/workflows/ci.yml/badge.svg?branch=main
[ci-url]: https://github.com/paradoxuum/commander/actions/workflows/ci.yml
[ci-badge]: https://github.com/paradoxuum/centurion/actions/workflows/ci.yml/badge.svg?branch=main
[ci-url]: https://github.com/paradoxuum/centurion/actions/workflows/ci.yml

<a href="https://commander.paradoxum.dev/">📖 Documentation</a>
<a href="https://centurion.paradoxum.dev/">📖 Documentation</a>
</div>


Expand Down
80 changes: 54 additions & 26 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,60 +1,88 @@
import starlight from "@astrojs/starlight";
import { defineConfig } from "astro/config";

import tailwind from "@astrojs/tailwind";
import starlightUtils from "@lorenzo_lewis/starlight-utils";
import starlightLinksValidator from "starlight-links-validator";

// https://astro.build/config
export default defineConfig({
site: "https://commander.paradoxum.dev",
site: "https://centurion.paradoxum.dev",
redirects: {
"/reference": "/reference/decorators",
},
integrations: [
starlight({
title: "Commander",
title: "Centurion",
description: "Flexible command framework for roblox-ts",
social: {
github: "https://github.com/paradoxuum/commander",
github: "https://github.com/paradoxuum/centurion",
discord: "https://discord.roblox-ts.com/",
},
logo: {
dark: "src/assets/logo-dark.svg",
light: "src/assets/logo-light.svg",
replacesTitle: true,
},
sidebar: [
{
label: "Quick Start",
label: "Guides",
collapsed: true,
items: [
{
label: "Getting Started",
link: "getting-started",
label: "Quick Start",
items: [
{
label: "Getting Started",
link: "/guides",
},
{
label: "Examples",
link: "/guides/examples",
},
],
},
{
label: "Examples",
link: "examples",
label: "Commands",
autogenerate: {
directory: "/guides/commands",
},
},
{
label: "Types",
autogenerate: {
directory: "/guides/types",
},
},
{
label: "Registration",
autogenerate: {
directory: "/guides/registration",
},
},
],
},
{
label: "Commands",
autogenerate: {
directory: "commands",
},
},
{
label: "Types",
label: "Reference",
collapsed: true,
autogenerate: {
directory: "types",
directory: "/reference",
},
},
{
label: "Registration",
autogenerate: {
directory: "registration",
],
customCss: ["./src/custom.scss"],
components: {
Header: "/src/components/Header.astro",
},
plugins: [
starlightLinksValidator({
errorOnRelativeLinks: false,
}),
starlightUtils({
multiSidebar: {
switcherStyle: "horizontalList",
},
},
}),
],
customCss: ["./src/tailwind.css", "./src/custom.scss"],
}),
tailwind({
applyBaseStyles: false,
}),
],
});
5 changes: 2 additions & 3 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@
"dependencies": {
"@astrojs/check": "^0.7.0",
"@astrojs/starlight": "^0.25.0",
"@astrojs/starlight-tailwind": "^2.0.3",
"@astrojs/tailwind": "^5.1.0",
"@fontsource-variable/jetbrains-mono": "^5.0.21",
"@lorenzo_lewis/starlight-utils": "^0.1.1",
"astro": "^4.11.5",
"sharp": "^0.33.4",
"tailwindcss": "^3.4.4",
"starlight-links-validator": "^0.9.1",
"typescript": "^5.5.3"
},
"devDependencies": {
Expand Down
53 changes: 45 additions & 8 deletions docs/public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 851ea4d

Please sign in to comment.