MD good practices

PouletteMC · PouletteMC · commit e9cb43d61350 · 2025-06-03T14:50:04.000+02:00
diff --git a/docs/API/about.md b/docs/API/about.md
@@ -13,7 +13,7 @@ The API is still in development. It is **NOT** perfect and will be improved in t
 :::
 
 :::info This guide is aimed at developers
-The following tips and information is aimed at developers wanting to create apps that utilize the API. If you are a regular user this may not be for you. 
+The following tips and information is aimed at developers wanting to create apps that utilize the API. If you are a regular user this may not be for you.
 As such some steps will assume that you already have basic knowledge of how API calls work and that you can read a documentation.
 :::
 
@@ -60,7 +60,6 @@ Standalone software allow you to make API calls from a nice interface. These sof
   You can download Insomnia <a href="https://insomnia.rest/download">here</a><img src="/img/docs/intro-api/insomnia.png"></img></TabItem>
 </Tabs>
 
-
 ### IDE extensions {#-ide-extensions}
 
 If you plan on writing code that leverages the API, you may want to use an IDE extension. Visual Studio Code being the most popular, here are a few options for it.
@@ -73,5 +72,3 @@ If you plan on writing code that leverages the API, you may want to use an IDE e
 ## API Endpoints {#-api-endpoints}
 
 View all [implemented endpoints](/api/endpoints).
-
-
diff --git a/docs/API/admin.md b/docs/API/admin.md
@@ -21,4 +21,4 @@ These routes require admin rights:
 | DELETE | /api/v2/users/:userId | Delete an existing user |
 | POST | /api/v2/users/wipe/sessions | Wipe all active sessions |
 
-For more info about these routes visit the [Users API Documentation](/apis/v2#tag/Users).
+For more info about these routes visit the [Users API Documentation](/apis/v2#tag/Users).
diff --git a/docs/advanced/java-path-update.md b/docs/advanced/java-path-update.md
@@ -8,6 +8,7 @@ keywords: [java, version, java-version, java-path, update, path]
 With MCSS you can use different versions of java for each of your servers, or set a global override for the version of java that is used by all servers.
 
 ## Finding the path to the Java executable {#-java-path}
+
 :::tip
 MCSS now (versions 12.6 and above) includes a Java path picker !<br/>
 The different installed versions are automatically detected and you can easily switch between them, so you can skip this section.<br/>
diff --git a/docs/advanced/tweak-java-path-detection.md b/docs/advanced/tweak-java-path-detection.md
@@ -10,7 +10,8 @@ In mcss you can use the 'Java Path Picker' to easily change the java version of
 ![explorer path](/img/docs/java-path/java-path-picker.png)
 
 These are the default search locations:
-```
+
+``` powershell
 C:\Program Files (x86)\Java
 C:\Program Files\Java
 C:\Program Files (x86)\Eclipse Adoptium
@@ -25,6 +26,7 @@ If you have installed Java in another locations you can manually add these to th
 Mcss must be fully closed before you make these changes. The setting is called `potentialInstalledJavaLocations`.
 
 Example:
+
 ```json
 ...
 "potentialInstalledJavaLocations": [
@@ -34,4 +36,4 @@ Example:
     "D:\\Program Files\\Eclipse Foundation"
 ]
 ...
-```
+```
diff --git a/docs/advanced/using-playit.gg-with-mcss.md b/docs/advanced/using-playit.gg-with-mcss.md
@@ -27,7 +27,7 @@ If you're having issues following this guide, there are plenty of video tutorial
 
 Creating an account on playit is extremely simple.  
 You can go to the website [of playit](https://playit.gg), and click on the "Login" button in the top right corner of the page.  
-There, you can click on "Create an Account" to go to the creation page. 
+There, you can click on "Create an Account" to go to the creation page.
 
 After creating the account, you'll be met with an "onboarding" process.  
 This is really simple, but we'll go over it anyway.
@@ -44,8 +44,6 @@ At this point, your website should look something like this:
 
 ![Full screen screenshot with the playit.gg onboarding process](/img/docs/playitgg/playitonboarding.png)
 
-
-
 After that's done, you'll have to define the rules for the first tunnel.  
 Click on "Create Tunnel" to proceed.  
 
@@ -75,7 +73,6 @@ We'll use the X's in the example below, but be sure to replace the IP and PORT w
 To connect to the server, we just take the IP (in this case `XX.ip.gl.ply.gg`) and we add the port (in this case `47XXX`) after a colon.  
 The result would be `XX.ip.gl.ply.gg:47XXX`. It is important to use the port, as without it the tunnel won't work.
 
-
 ## Using playit.gg for the web panel {#-using-playit-for-the-panel}
 
 To use playit.gg for the web panel, first enable the panel following our [documentation page](/webpanel/getting-started).  
@@ -97,9 +94,8 @@ This tunnel has additional settings, but all we care about is the port. You shou
 
 After the tunnel is created, we follow the same process that we used to connect to the minecraft server above.
 
-:::info 
+:::info
 Due to the structure of the tunnel, you **have** to specify `https://` before the IP if you set SSL to true in the panel settings. Just like above, we need the port added to the end of the IP.
 
 It is normal to see the "Website not secure" warning when loading the panel.
 :::
-
diff --git a/docs/basic/create-server/Fabric/create-fabric-server-manually.md b/docs/basic/create-server/Fabric/create-fabric-server-manually.md
@@ -18,6 +18,7 @@ You can now use the downloaded jar as the source file for a new server by clicki
 :::note Using an installer
 If you have a Fabric installer instead of a single launcher jar, you can follow this procedure to create a server, though it's recommended to use the standalone file method as presented above.
 :::
+
 ## Create the Fabric server {#-create-the-fabric-server}
 
 Once the download is done, open the file `fabric-installer-<fabric-version>.jar` to begin the Fabric server installation. <br/>
diff --git a/docs/basic/create-server/Forge/create-forge-server-manually.md b/docs/basic/create-server/Forge/create-forge-server-manually.md
@@ -77,6 +77,7 @@ REM  pass them to this script directly
 java @user_jvm_args.txt @libraries/net/minecraftforge/forge/1.18.1-39.0.45/win_args.txt %*
 pause
 ```
+
 You must remove the *pause* statement at the bottom and add the *nogui* parameter, as well as replace `java` with your full path to java.exe.<br/>
 You can use the Path Picker (in the server's settings) to find it, make sure to use [the right version](/advanced/java-version.md) depending on your server.
 
@@ -93,4 +94,4 @@ REM  pass them to this script directly
 At the first server start, the console will show an error asking you to accept the EULA. To do so, click on "servers > show in file explorer" and open the "eula.txt" file. Change the line `eula=false` to `eula=true` and start the server again. <br/>
 This time, it will fully start and you will be able to connect from you Minecraft client.
 
-That's it, now you have a fully functioning forge server in mcss.
+That's it, now you have a fully functioning forge server in mcss.
diff --git a/docs/basic/create-server/sourcing-server-file.md b/docs/basic/create-server/sourcing-server-file.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 title: Sourcing a server file
 description: Where to find and download server files
 keywords: [server, file, download, source, download, url]
@@ -25,22 +25,22 @@ How to use the **build tools** is not covered in this guide.
 
 ### Downloads{#-downloads}
 
-|     Name              	| Official Source   | Download
+|     Name               | Official Source   | Download
 |----------                 |:----------:       |----------
-| Vanilla (latest) 	        |      ✔️           | [https://www.minecraft.net/download/server](https://www.minecraft.net/download/server)
-| Vanilla       	        |      ❌           | [https://getbukkit.org/download/vanilla](https://getbukkit.org/download/vanilla)
-| CraftBukkit           	|      ❌           | [https://getbukkit.org/download/craftbukkit](https://getbukkit.org/download/craftbukkit)
-| Spigot                 	|      ❌           | [https://getbukkit.org/download/spigot](https://getbukkit.org/download/spigot)
-| Paper                    	|      ✔️           | [https://papermc.io/downloads](https://papermc.io/downloads)
-| Bedrock (latest) 	        |      ✔️           | [https://www.minecraft.net/download/server/bedrock](https://www.minecraft.net/download/server/bedrock)
-| BungeeCord          	    |      ✔️           | [https://ci.md-5.net/job/BungeeCord/](https://ci.md-5.net/job/BungeeCord/)
-| Waterfall          	    |      ✔️           | [https://papermc.io/downloads#Waterfall](https://papermc.io/downloads#Waterfall)
-| Forge Installer  	        |      ✔️           | [https://files.minecraftforge.net/net/minecraftforge/forge/](https://files.minecraftforge.net/net/minecraftforge/forge/)
+| Vanilla (latest)          |      ✔️           | [https://www.minecraft.net/download/server](https://www.minecraft.net/download/server)
+| Vanilla                |      ❌           | [https://getbukkit.org/download/vanilla](https://getbukkit.org/download/vanilla)
+| CraftBukkit            |      ❌           | [https://getbukkit.org/download/craftbukkit](https://getbukkit.org/download/craftbukkit)
+| Spigot                  |      ❌           | [https://getbukkit.org/download/spigot](https://getbukkit.org/download/spigot)
+| Paper                     |      ✔️           | [https://papermc.io/downloads](https://papermc.io/downloads)
+| Bedrock (latest)          |      ✔️           | [https://www.minecraft.net/download/server/bedrock](https://www.minecraft.net/download/server/bedrock)
+| BungeeCord               |      ✔️           | [https://ci.md-5.net/job/BungeeCord/](https://ci.md-5.net/job/BungeeCord/)
+| Waterfall               |      ✔️           | [https://papermc.io/downloads#Waterfall](https://papermc.io/downloads#Waterfall)
+| Forge Installer           |      ✔️           | [https://files.minecraftforge.net/net/minecraftforge/forge/](https://files.minecraftforge.net/net/minecraftforge/forge/)
 | Fabric Launcher          |      ✔️           | [https://fabricmc.net/use/server/](https://fabricmc.net/use/server/)
 
 ### Installer Guides {#-installer-guides}
 
-| Name   	                | Official Source   | Installation guide
-|----------                 |:----------:  	    |----------
+| Name                    | Official Source   | Installation guide
+|----------                 |:----------:       |----------
 | Forge                     |      ✔️           | [Forge Guide](Forge/create-forge-server)
-| Fabric 	                |      ✔️          	| [Fabric guide](Fabric/create-fabric-server-manually)
+| Fabric                  |      ✔️           | [Fabric guide](Fabric/create-fabric-server-manually)
diff --git a/docs/basic/supported-server-types.md b/docs/basic/supported-server-types.md
@@ -18,11 +18,11 @@ Even if you don't want any plugins, we recommend you use [paper](#-plugin-suppor
 
 Plugins are third party add-ons you can add to your server. They can do a lot of different things, from fixing bugs to adding minigames or RPG-like gameplay.
 
-|     Name    	| Description                                                          	| Recommended 	| Download        	|
-|:-----------:	|----------------------------------------------------------------------	|:-----------:	|-----------------	|
-| CraftBukkit 	| Most basic version, only supports Bukkit plugins                     	|      ❌      	| [Bukkit downloads](https://getbukkit.org/download/craftbukkit) 	|
-|    Spigot   	| Evolution of Bukkit, with more features and support for more plugins 	|      ➖      	| [Spigot downloads](https://getbukkit.org/download/spigot) 	|
-|    Paper    	| Evolution of Spigot, much faster with support for more plugins       	|      ✔️      	| [Paper downloads](https://papermc.io/downloads) 	|
+|     Name     | Description                                                           | Recommended  | Download         |
+|:-----------: |---------------------------------------------------------------------- |:-----------: |----------------- |
+| CraftBukkit  | Most basic version, only supports Bukkit plugins                      |      ❌       | [Bukkit downloads](https://getbukkit.org/download/craftbukkit)  |
+|    Spigot    | Evolution of Bukkit, with more features and support for more plugins  |      ➖       | [Spigot downloads](https://getbukkit.org/download/spigot)  |
+|    Paper     | Evolution of Spigot, much faster with support for more plugins        |      ✔️       | [Paper downloads](https://papermc.io/downloads)  |
 
 ## Modded servers {#-modded-servers}
 
@@ -32,15 +32,15 @@ There are two types of modded servers, which are not compatible. They each have
 To use any of these version with MCSS, please follow their respective installation guide
 :::
 
-| Name   	| Description                                                                            	| Installation guide 	|
-|--------	|----------------------------------------------------------------------------------------	|--------------------	|
-| Forge  	| Most widely used server type, with over 84 000 mods available                          	| [Forge Guide](/basic/create-server/Forge/create-forge-server)      	|
-| Fabric 	| More recent than Forge, with an emphasis on performance and about 3 000 mods available 	| [Fabric guide](/basic/create-server/Fabric/create-fabric-server-manually)     	|
+| Name    | Description                                                                             | Installation guide  |
+|-------- |---------------------------------------------------------------------------------------- |-------------------- |
+| Forge   | Most widely used server type, with over 84 000 mods available                           | [Forge Guide](/basic/create-server/Forge/create-forge-server)       |
+| Fabric  | More recent than Forge, with an emphasis on performance and about 3 000 mods available  | [Fabric guide](/basic/create-server/Fabric/create-fabric-server-manually)      |
 
 ## Proxy / Network {#-proxy--network}
 
-| Name       	| Description                                                     	| Download             	|
-|------------	|-----------------------------------------------------------------	|----------------------	|
-| BungeeCord 	| Developed by Spigot's team, it supports plugins                	| [BungeeCord downloads](https://ci.md-5.net/job/BungeeCord/) 	|
-| Waterfall  	| Developed by Paper's team, it's a faster version of BungeeCord 	| [Waterfall downloads](https://papermc.io/downloads#Waterfall)  	|
-| Geyser     	| Allows Java and PE players to play on the same server           	| [Geyser downloads](https://ci.opencollab.dev//job/GeyserMC/job/Geyser/job/master/)    	|
+| Name        | Description                                                      | Download              |
+|------------ |----------------------------------------------------------------- |---------------------- |
+| BungeeCord  | Developed by Spigot's team, it supports plugins                 | [BungeeCord downloads](https://ci.md-5.net/job/BungeeCord/)  |
+| Waterfall   | Developed by Paper's team, it's a faster version of BungeeCord  | [Waterfall downloads](https://papermc.io/downloads#Waterfall)   |
+| Geyser      | Allows Java and PE players to play on the same server            | [Geyser downloads](https://ci.opencollab.dev//job/GeyserMC/job/Geyser/job/master/)     |
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/intro.md b/docs/intro.md
