Skip to content

Commit

Permalink
feat: new docs wip
Browse files Browse the repository at this point in the history
  • Loading branch information
twlite committed May 28, 2024
1 parent 6aaed13 commit 001eacf
Show file tree
Hide file tree
Showing 7 changed files with 516 additions and 0 deletions.
15 changes: 15 additions & 0 deletions apps/docs/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions apps/docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Introduction
description: 'Welcome to the Discord Player documentation!'
---

---

## What is Discord Player?

Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript. It is built on top of the [discord-voip](https://npm.im/discord-voip) library and offers a comprehensive set of customizable tools, making it one of the most feature enrich framework in town.

Discord Player is designed to be simple to use, yet powerful enough to handle all your music bot needs. It is built with developer experience in mind, offering a clean and intuitive API that makes it easy to get started with Discord Player. With Discord Player, what you see is what you get. No more complicated setups or confusing configurations. Just install Discord Player, and you're ready to go.

---

## Pre-requisites

We try our best to make Discord Player as easy to use as possible. However, there are a few things you need to know before you start using Discord Player. To get the most out of Discord Player, you should have a basic understanding of the following:

<CardGroup cols={2}>
<Card title="Knowledge of JavaScript" icon="js" href="https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics">
Since Discord Player is a JavaScript library, you should have a basic understanding of JavaScript to use it effectively.
</Card>
<Card title="Knowledge of Discord.js" icon="discord" href="https://discord.js.org">
Discord Player is built on top of Discord.js, so you should have a basic understanding of Discord.js to use Discord Player effectively.
</Card>
<Card title="Knowledge of Node.js" icon="node" href="https://nodejs.org/en/docs/">
Discord Player is built using Node.js APIs, so you must have a basic understanding of Node.js to use Discord Player effectively.
</Card>
</CardGroup>

## Ready to get started?

If you have the understanding of the above concepts, you're ready to start using Discord Player. You can start by installing Discord Player and creating your first Music Bot. If you're new to Discord Player, we recommend you start with the [Quick Start](/quickstart) guide to get a better understanding of how Discord Player works.

Here are few other resources to help you get started with Discord Player:

<CardGroup cols={2}>
<Card title="Quick Start" icon="code" href="/quickstart">
Get started with Discord Player by creating your first Discord Music Bot.
</Card>
<Card title="Using Hooks" icon="screwdriver-wrench" href="/hooks/introduction">
Learn how to use Discord Player's hooks to simplify your bot's code and make it more maintainable.
</Card>
<Card title="Synchronized Lyrics" icon="note" href="/lyrics/introduction">
Learn how to add synchronized lyrics to your music bot using Discord Player's lyrics api.
</Card>
<Card title="Custom Extractors" icon="music" href="/extractors/introduction">
Learn how to add custom audio providers to your music bot using Discord Player's extractors api.
</Card>
<Card title="Performance Optimization" icon="rocket" href="/performance/introduction">
Learn how to optimize your music bot's performance using Discord Player's performance optimization techniques.
</Card>
<Card title="Making your bot tos-friendly" icon="lock" href="/tos">
Learn how to avoid tos-violations when using Discord Player.
</Card>
<Card title="Discord Server" icon="discord" href="https://androz2091.fr/discord">
Join our Discord server to get help, share your projects, and more.
</Card>
<Card title="Source Code" icon="github" href="https://github.com/androz2091/discord-player">
Contribute to Discord Player by submitting bug reports, feature requests, and more.
</Card>
</CardGroup>
15 changes: 15 additions & 0 deletions apps/docs/logo/dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions apps/docs/logo/light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
95 changes: 95 additions & 0 deletions apps/docs/mint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "Discord Player",
"seo": {
"indexHiddenPages": true
},
"search": {
"prompt": "Search documentation..."
},
"modeToggle": {
"default": "dark"
},
"feedback": {
"raiseIssue": true,
"suggestEdit": true,
"thumbsRating": true
},
"metadata": {
"title": "Discord Player",
"description": "Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript.",
"author": "AndrozDev",
"twitter": "@androz2091",
"image": "/logo/dark.svg",
"keywords": "discord-player, Discord Player, discord, discord.js, music, discord-music-bot, music-bot"
},
"logo": {
"dark": "/logo/dark.svg",
"light": "/logo/light.svg"
},
"favicon": "/favicon.svg",
"colors": {
"primary": "#dc2626",
"light": "#EC5151",
"dark": "#C31717",
"anchors": {
"from": "#dc2626",
"to": "#EC5151"
}
},
"topbarLinks": [
{
"name": "API",
"url": "https://discord-player.js.org/docs"
},
{
"name": "GitHub",
"url": "https://github.com/androz2091/discord-player"
}
],
"topbarCtaButton": {
"name": "Discord",
"url": "https://androz2091.fr/discord"
},
"tabs": [
{
"name": "Examples",
"url": "examples"
}
],
"anchors": [
{
"name": "Documentation",
"icon": "book-open-cover",
"url": "/introduction"
},
{
"name": "API Documentation",
"icon": "code",
"url": "https://discord-player.js.org/docs"
},
{
"name": "Discord",
"icon": "discord",
"url": "https://androz2091.fr/discord"
},
{
"name": "GitHub",
"icon": "github",
"url": "https://github.com/androz2091/discord-player"
}
],
"navigation": [
{
"group": "Get Started",
"pages": [
"introduction",
"quickstart"
]
}
],
"footerSocials": {
"discord": "https://androz2091.fr/discord",
"github": "https://github.com/androz2091/discord-player"
}
}
23 changes: 23 additions & 0 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "docs",
"version": "0.1.0",
"description": "Discord Player documentation",
"main": "index.js",
"scripts": {
"dev": "mintlify dev",
"install": "mintlify install"
},
"repository": {
"type": "git",
"url": "git+https://github.com/Androz2091/discord-player.git"
},
"author": "twlite <hello@twlite.dev>",
"license": "MIT",
"bugs": {
"url": "https://github.com/Androz2091/discord-player/issues"
},
"homepage": "https://github.com/Androz2091/discord-player#readme",
"dependencies": {
"mintlify": "^4.0.160"
}
}
Loading

0 comments on commit 001eacf

Please sign in to comment.