From c6f6d4bab150ccc5df9baa68139e272e3e0011ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?To=CF=80?= Date: Tue, 15 Aug 2023 21:08:59 +0200 Subject: [PATCH] reformat --- docs/api/index.md | 1 - docs/api/rest.md | 20 ++++++++++---------- docs/api/websocket.md | 8 ++++---- docs/changelog.md | 1 + docs/configuration/index.md | 3 +++ docs/getting-started.md | 1 - docs/overrides/home.html | 6 +++--- docs/stylesheets/style.css | 1 + 8 files changed, 22 insertions(+), 19 deletions(-) diff --git a/docs/api/index.md b/docs/api/index.md index 51920acd1..c367ca9ed 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -129,7 +129,6 @@ the JDA client takes advantage of JDA's websocket write thread to send OP 4s for Fields marked with `?` are optional and types marked with `?` are nullable. - ## Resuming What happens after your client disconnects is dependent on whether the session has been configured for resuming. diff --git a/docs/api/rest.md b/docs/api/rest.md index 7de28b756..e9c8eb247 100644 --- a/docs/api/rest.md +++ b/docs/api/rest.md @@ -88,11 +88,11 @@ GET /v4/sessions/{sessionId}/players ##### Voice State -| Field | Type | Description | -|------------|--------|---------------------------------------------------------------------------------------------| -| token | string | The Discord voice token to authenticate with | -| endpoint | string | The Discord voice endpoint to connect to | -| sessionId | string | The Discord voice session id to authenticate with | +| Field | Type | Description | +|-----------|--------|---------------------------------------------------| +| token | string | The Discord voice token to authenticate with | +| endpoint | string | The Discord voice endpoint to connect to | +| sessionId | string | The Discord voice session id to authenticate with | `token`, `endpoint`, and `sessionId` are the 3 required values for connecting to one of Discord's voice servers. `sessionId` is provided by the Voice State Update event sent by Discord, whereas the `endpoint` and `token` are provided @@ -621,11 +621,11 @@ Response: ###### Load Result Data - Playlist -| Field | Type | Description | -|------------|---------------------------------------|---------------------------------------------| -| info | [PlaylistInfo](#playlist-info) object | The info of the playlist | -| pluginInfo | Object | Addition playlist info provided by plugins | -| tracks | array of [Track](#track) objects | The tracks of the playlist | +| Field | Type | Description | +|------------|---------------------------------------|--------------------------------------------| +| info | [PlaylistInfo](#playlist-info) object | The info of the playlist | +| pluginInfo | Object | Addition playlist info provided by plugins | +| tracks | array of [Track](#track) objects | The tracks of the playlist | ###### Playlist Info diff --git a/docs/api/websocket.md b/docs/api/websocket.md index c09b65e62..7fb4a06a2 100644 --- a/docs/api/websocket.md +++ b/docs/api/websocket.md @@ -337,10 +337,10 @@ Dispatched when a track throws an exception. ##### Severity -| Severity | Description | -|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `common` | The cause is known and expected, indicates that there is nothing wrong with the library itself | -| `suspicious` | The cause might not be exactly known, but is possibly caused by outside factors. For example when an outside service responds in a format that we do not expect | +| Severity | Description | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `common` | The cause is known and expected, indicates that there is nothing wrong with the library itself | +| `suspicious` | The cause might not be exactly known, but is possibly caused by outside factors. For example when an outside service responds in a format that we do not expect | | `fault` | The probable cause is an issue with the library or there is no way to tell what the cause might be. This is the default level and other levels are used in cases where the thrower has more in-depth knowledge about the error |
diff --git a/docs/changelog.md b/docs/changelog.md index 43aef7bd9..aa5979d92 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -10,6 +10,7 @@ The most noteworthy of these, as well as any features and breaking changes, are ## v4 ### v4.0.0-beta.3 + * Update lavaplayer to [`2.0.0`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.0) - Fixed YouTube 403 errors & YouTube access token errors ### v4.0.0-beta.2 diff --git a/docs/configuration/index.md b/docs/configuration/index.md index f2bc4addb..b4f7a60be 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -7,18 +7,21 @@ description: How to configure Lavalink The server configuration is done in `application.yml`. You can find an example below. ## Example application.yml +
application.yml ```yaml title="application.yml" --8<-- "LavalinkServer/application.yml.example" ``` +
Alternatively, you can also use environment variables to configure the server. The environment variables are named the same as the keys in the `application.yml` file, but in uppercase and with `.` replaced with `_`. For example, `server.port` becomes `SERVER_PORT`. For arrays, the index is appended to the key, starting at 0. For example, `LAVALINK_PLUGINS_0_DEPENDENCY` refers to the `dependency` key of the first plugin. ## Example environment variables +
environment variables diff --git a/docs/getting-started.md b/docs/getting-started.md index edab5b40d..a9a189d83 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -27,4 +27,3 @@ If you want to run the Lavalink server without it closing when you close the ter ## Need Help? Join the [Lavalink support Discord](https://discord.gg/ZW4s47Ppw4) for help or questions. - diff --git a/docs/overrides/home.html b/docs/overrides/home.html index 9fc6970f4..ad6a2fb2c 100644 --- a/docs/overrides/home.html +++ b/docs/overrides/home.html @@ -10,13 +10,13 @@
diff --git a/docs/stylesheets/style.css b/docs/stylesheets/style.css index 5e1504614..07bf50f78 100644 --- a/docs/stylesheets/style.css +++ b/docs/stylesheets/style.css @@ -9,6 +9,7 @@ .container { margin-top: 1rem; } + .container .logo { text-align: center; }