Skip to content

Commit

Permalink
Adjust the new logs and thus readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomato6966 committed Sep 24, 2024
1 parent c4f0eb5 commit f45cb55
Show file tree
Hide file tree
Showing 13 changed files with 87 additions and 736 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Profi

# Install

Latest stable Version: **`v2.1.3`**
Latest stable Version: **`v2.4.0`**

<details><summary>👉 via NPM</summary>

Expand All @@ -36,7 +36,7 @@ npm install --save lavalink-client
Dev Version: (Current)

```bash
npm install tomato6966/lavalink-client
npm install --save tomato6966/lavalink-client
```

</details>
Expand All @@ -58,8 +58,9 @@ yarn add tomato6966/lavalink-client
# Documentation

Check out the [Documentation](https://tomato6966.github.io/lavalink-client/)
- See all [Manager-Events, e.g. for Track / player and general errors / logs](https://tomato6966.github.io/lavalink-client/interfaces/Types_Manager.LavalinkManagerEvents.html)
- See all [NodeManager-Events e.g. for Node Errors / logs](https://tomato6966.github.io/lavalink-client/interfaces/Types_Node.NodeManagerEvents.html)
- See all [Manager-Events, e.g. for Track / player and general errors / logs](https://tomato6966.github.io/lavalink-client/extra/manager-events)
- See all [NodeManager-Events e.g. for Node Errors / logs](https://tomato6966.github.io/lavalink-client/extra/node-events)
- See the Guide on [How to do resuming](https://tomato6966.github.io/lavalink-client/extra/resuming)

# Used in:

Expand Down
55 changes: 0 additions & 55 deletions docs/README.md

This file was deleted.

97 changes: 57 additions & 40 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,94 +1,111 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc'
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc"

// https://astro.build/config
export default defineConfig({
site: 'https://tomato6966.github.io/lavalink-client/',
base: '/',
site: "https://tomato6966.github.io/lavalink-client/",
base: "/",
integrations: [
starlight({
title: 'Lavalink Client',
title: "Lavalink Client",
social: {
github: 'https://github.com/Tomato6966/lavalink-client',
//discord: 'https://discord.gg/',
github: "https://github.com/Tomato6966/lavalink-client",
discord: "https://discord.gg/AsgD3gtPnb",
email: "mailto:[email protected]",
},
editLink: {
baseUrl: 'https://github.com/Tomato6966/lavalink-client/tree/main',
baseUrl: "https://github.com/Tomato6966/lavalink-client/tree/main",
},
plugins: [
// Generate the documentation.
starlightTypeDoc({
entryPoints: ['../src/index.ts'],
tsconfig: '../tsconfig.json',
entryPoints: ["../src/structures/**/*.ts"],
tsconfig: "../tsconfig.json",
typeDoc: {
useCodeBlocks: true,
parametersFormat: 'table',
propertiesFormat: 'table',
enumMembersFormat: 'table',
typeDeclarationFormat: 'table',
indexFormat: 'table',
parametersFormat: "table",
propertiesFormat: "table",
enumMembersFormat: "table",
typeDeclarationFormat: "table",
indexFormat: "table",
expandParameters: true,
name: 'Lavalink Client',
name: "Lavalink Client",
},
pagination: true,
}),
],
sidebar: [
{
label: 'Getting Started',
label: "Getting Started",
collapsed: true,
items: [
{
label: 'installation',
link: '/home/installation',
label: "installation",
link: "/home/installation",
},
{
label: 'Features',
link: '/home/features',
label: "Setup Lavalink-Server",
link: "/home/setup-lavalink",
},
{
label: 'Example Guide',
link: '/home/example',
label: "Features",
link: "/home/features",
},
{
label: 'Sample Configuration',
link: '/home/configuration',
}
label: "Example Guide",
link: "/home/example",
},
{
label: "Sample Configuration",
link: "/home/configuration",
},
{
label: "Checkout Docs (Manager-Class)",
link: "/api/lavalinkmanager/classes/lavalinkmanager"
}
],
},
{
label: 'Extra',
label: "Extra",
collapsed: true,
items: [
{
label: 'Manager Events',
link: '/extra/manager-events',
label: "Manager Events",
link: "/extra/manager-events",
},
{
label: 'Node Events',
link: '/extra/node-events',
label: "Node Events",
link: "/extra/node-events",
},
{
label: 'Resuming',
link: '/extra/resuming',
label: "Resuming",
link: "/extra/resuming",
}
]
},
typeDocSidebarGroup,
{
label: 'GitHub',
link: 'https://github.com/Tomato6966/lavalink-client',
label: "GitHub",
link: "https://github.com/Tomato6966/lavalink-client",
},
{
label: 'NPM',
link: 'https://npmjs.com/lavalink-client',
label: "NPM",
link: "https://npmjs.com/lavalink-client",
},
{
label: 'Example Bot',
link: 'https://github.com/Tomato6966/lavalink-client/tree/main/testBot',
label: "Example Bot",
link: "https://github.com/Tomato6966/lavalink-client/tree/main/testBot",
},
{
label: "Lavalink-Discord",
link: "https://discord.gg/lavalink-1082302532421943407"
},
{
label: "Lavalink-Web",
link: "https://lavalink.dev"
}
],
}),
],
Expand Down
7 changes: 4 additions & 3 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docs",
"name": "lavalink-client-docs",
"type": "module",
"version": "0.0.1",
"version": "2.0.0",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
Expand All @@ -13,10 +13,11 @@
"@astrojs/check": "^0.9.3",
"@astrojs/starlight": "^0.28.2",
"astro": "^4.15.3",
"marked": "^14.1.2",
"sharp": "^0.32.5",
"starlight-typedoc": "^0.16.0",
"typedoc": "^0.26.7",
"typedoc-plugin-markdown": "^4.2.7",
"typescript": "^5.6.2"
}
}
}
21 changes: 21 additions & 0 deletions docs/src/components/versionlog.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
import fs from "fs";
import path from "path";
import matter from "gray-matter";
import { marked } from "marked";
const fileContents = fs.readFileSync("../README.md", "utf-8");
const { content } = matter(fileContents);
const startIndex = content.indexOf("# UpdateLog");
let filteredContent = "";
if (startIndex !== -1) {
filteredContent = content.slice(startIndex);
}
const markdownHtml = marked(filteredContent);
---

<div class="markdown" set:html={markdownHtml}></div>
62 changes: 0 additions & 62 deletions docs/src/content/docs/extra/manager-events.mdx

This file was deleted.

49 changes: 0 additions & 49 deletions docs/src/content/docs/extra/node-events.mdx

This file was deleted.

Loading

0 comments on commit f45cb55

Please sign in to comment.