Skip to content

Commit

Permalink
Rewriting documentation to mkdocs 🤓
Browse files Browse the repository at this point in the history
  • Loading branch information
200percentmicky committed Oct 14, 2023
1 parent 13bec50 commit e27ccb7
Show file tree
Hide file tree
Showing 31 changed files with 898 additions and 493 deletions.
18 changes: 9 additions & 9 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,15 @@ COLOR_MUSIC=0093FF
# If you're using a custom emoji, only provide the ID of the emoji. To use custom emojis
# for the UI Emojis, provide the entire string output of the emoji. You can get the emoji's
# ID anywhere in Discord by doing "\:emoji:" in a text channel.
EMOJI_OK=
EMOJI_WARN=
EMOJI_ERROR=
EMOJI_INFO=
EMOJI_QUESTION=
EMOJI_NO=🚫
EMOJI_LOADING=
EMOJI_CUTIE=🎶
EMOJI_MUSIC=🎵
EMOJI_OK=:white_check_mark:
EMOJI_WARN=:warning:
EMOJI_ERROR=:x:
EMOJI_INFO=:information_source:
EMOJI_QUESTION=:question_mark:
EMOJI_NO=:no_entry_sign:
EMOJI_LOADING=:watch:
EMOJI_CUTIE=:notes:
EMOJI_MUSIC=:musical_note:

# Reactions
# If you're using a custom emoji, only provide the ID of the emoji.
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: ci
on:
push:
branches:
- develop
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,30 @@
<h1 align="center">
<h1 align="center" style="font-weight: bold; font-style: italic;">
<img src="https://media.discordapp.net/attachments/375453081631981568/808626634210410506/deejaytreefiddy.png" width=250>
</h1>
<h1 align="center" style="font-weight: bold; font-style: italic;">ChadMusic - The Chad Music Bot</h1>

<h1 align="center">ChadMusic</h1>

![GitHub](https://img.shields.io/github/license/200percentmicky/chadmusic)
[![Discord](https://img.shields.io/discord/449606846697963531.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/qQuJ9YQ)
[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/0-percent-optimized.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/fuck-it-ship-it.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/gluten-free.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](https://forthebadge.com)
[![forthebadge](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxODAuNjA5NDA1NTE3NTc4MTIiIGhlaWdodD0iMzUiIHZpZXdCb3g9IjAgMCAxODAuNjA5NDA1NTE3NTc4MTIgMzUiPjxyZWN0IHdpZHRoPSI4NS4zMjgxNDAyNTg3ODkwNiIgaGVpZ2h0PSIzNSIgZmlsbD0iI2ZmZWIwMCIvPjxyZWN0IHg9Ijg1LjMyODE0MDI1ODc4OTA2IiB3aWR0aD0iOTUuMjgxMjY1MjU4Nzg5MDYiIGhlaWdodD0iMzUiIGZpbGw9IiM3MzM3MDMiLz48dGV4dCB4PSI0Mi42NjQwNzAxMjkzOTQ1MyIgeT0iMTcuNSIgZm9udC1zaXplPSIxMiIgZm9udC1mYW1pbHk9IidSb2JvdG8nLCBzYW5zLXNlcmlmIiBmaWxsPSIjMDAwMDAwIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBhbGlnbm1lbnQtYmFzZWxpbmU9Im1pZGRsZSIgbGV0dGVyLXNwYWNpbmc9IjIiPlBFRSBQRUU8L3RleHQ+PHRleHQgeD0iMTMyLjk2ODc3Mjg4ODE4MzYiIHk9IjE3LjUiIGZvbnQtc2l6ZT0iMTIiIGZvbnQtZmFtaWx5PSInTW9udHNlcnJhdCcsIHNhbnMtc2VyaWYiIGZpbGw9IiNGRkZGRkYiIHRleHQtYW5jaG9yPSJtaWRkbGUiIGZvbnQtd2VpZ2h0PSI5MDAiIGFsaWdubWVudC1iYXNlbGluZT0ibWlkZGxlIiBsZXR0ZXItc3BhY2luZz0iMiI+UE9PIFBPTzwvdGV4dD48L3N2Zz4=)](https://forthebadge.com)

A cool universal audio player for your Discord server that's based on a [forked](https://github.com/200percentmicky/chadtube) build of **[DisTube.js](https://distube.js.org)**.
![YouTube Music](https://img.shields.io/badge/YouTube_Music-FF0000?style=for-the-badge&logo=youtube-music&logoColor=white)
![Sound Cloud](https://img.shields.io/badge/sound%20cloud-FF5500?style=for-the-badge&logo=soundcloud&logoColor=white)
![Spotify](https://img.shields.io/badge/Spotify-1ED760?style=for-the-badge&logo=spotify&logoColor=white)
![Deezer](https://img.shields.io/badge/Deezer-FEAA2D?style=for-the-badge&logo=deezer&logoColor=white)
![Apple Music](https://img.shields.io/badge/Apple_Music-9933CC?style=for-the-badge&logo=apple-music&logoColor=white)

A universal audio playing Discord bot for your Discord server. It's built using a modified [fork](https://github.com/200percentmicky/chadtube) of **[DisTube.js](https://distube.js.org)**.

**[Add my bot to your server to try it out!](https://discord.com/api/oauth2/authorize?client_id=375450533114413056&permissions=1005972566&scope=applications.commands%20bot)**
### **[Read the Documentation](https://200percentmicky.github.io/chadmusic)**

**[Documentation](https://200percentmicky.github.io/chadmusic)**
## Features

# ✨ Features
* Supports up to 700+ websites.
- Anything supported by [yt-dlp](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md) is also supported on the bot.
- Supports audio and video attachments uploaded to Discord.
Expand All @@ -42,5 +49,6 @@ A cool universal audio player for your Discord server that's based on a [forked]
* ???
* Profit!

# License
ChadMusic is open source software. The software is licensed under GNU General Public License version 3 (GPL-v3). Read LICENSE for more information.
## License

ChadMusic is open source software. The software is licensed under GNU General Public License version 3 (GPL-v3).
Empty file removed docs/.nojekyll
Empty file.
9 changes: 0 additions & 9 deletions docs/_sidebar.md

This file was deleted.

Binary file added docs/assets/app_bot_scope.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_bot_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_copy_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_default_auth_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_message_intent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_oauth_tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/app_reset_token.png
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 e27ccb7

Please sign in to comment.