Format info and warning boxes using mkdocs syntax (#64)

R2Northstar · Sep 30, 2024 · 4c818c2 · 4c818c2
1 parent 46151c6
commit 4c818c2
Show file tree

Hide file tree

Showing 20 changed files with 81 additions and 81 deletions.
diff --git a/docs/Wiki/contributing.md b/docs/Wiki/contributing.md
@@ -8,8 +8,8 @@ description: Contribution guidelines
 
 Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRIBUTING.md) before creating an issue, if you believe that the issue is valid fill the provided template with the requested info.
 
-{% hint style="info" %}
-Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project.
-{% endhint %}
+!!! info
+    Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project.
+
 
 Check the [Development](development/README.md) section if you are unsure of where to open a ticket.
diff --git a/docs/Wiki/development/contributing-code-to-northstar.md b/docs/Wiki/development/contributing-code-to-northstar.md
@@ -4,9 +4,9 @@ description: Useful information when contributing to Northstar
 
 # Contributing code to Northstar
 
-{% hint style="info" %}
-WIP
-{% endhint %}
+!!! info
+    WIP
+
 
 ## Guidelines
 

diff --git a/docs/Wiki/development/debugging/README.md b/docs/Wiki/development/debugging/README.md
@@ -1,9 +1,9 @@
 # Debugging
 
-{% hint style="warning" %}
-Debugging Northstar is only recommended to experienced developers.
+!!! warning
+    Debugging Northstar is only recommended to experienced developers.
 If you need help figuring out an issue feel free to visit the Northstar Discord.
-{% endhint %}
+
 
 ## Contents
 * [Visual Studio](visualstudio.md)

diff --git a/docs/Wiki/development/debugging/x64dbg.md b/docs/Wiki/development/debugging/x64dbg.md
@@ -1,8 +1,8 @@
 # x64dbg
 
-{% hint style="warning" %}
-If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md).
-{% endhint %}
+!!! warning
+    If you are not experienced with x64dbg it its recommended to use [Visual Studio](visualstudio.md).
+
 
 
 ## Windows
@@ -32,9 +32,9 @@ If you are not experienced with x64dbg it its recommended to use [Visual Studio]
 
 ## Linux
 
-{% hint style="warning" %}
-Debugging Northstar under Linux is not trivial due to the direct dependency on Origin, unless you know your way around wine its recommended to debug on Windows.
-{% endhint %}
+!!! warning
+    Debugging Northstar under Linux is not trivial due to the direct dependency on Origin, unless you know your way around wine its recommended to debug on Windows.
+
 
 To simplify the use of x64dbg and automate running Origin a community member has created a script: [ns-linux-dbg](https://github.com/R2NorthstarTools/ns-linux-dbg)
 

diff --git a/docs/Wiki/development/northstarmasterserver/README.md b/docs/Wiki/development/northstarmasterserver/README.md
@@ -1,8 +1,8 @@
 # NorthstarMasterServer
 
-{% hint style="warning" %}
-The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas.
-{% endhint %}
+!!! warning
+    The old NodeJS master server has been replaced in favour of the Go rewrite called Atlas.
+
 
 ## Introduction
 

diff --git a/docs/Wiki/development/releases.md b/docs/Wiki/development/releases.md
@@ -6,9 +6,9 @@ description: >-
 
 # Releases
 
-{% hint style="info" %}
-WIP
-{% endhint %}
+!!! info
+    WIP
+
 
 ## General
 

diff --git a/docs/Wiki/development/reviewing.md b/docs/Wiki/development/reviewing.md
@@ -57,13 +57,13 @@ After leaving your comment, select the type of feedback.
 * **Approve**: You found no issues when looking at the code or during testing.
 * **Request changes**: Either something in the code doesn't look right or you found bugs during testing.
 
-{% hint style="warning" %}
-Approval reviews should **always** contain information about what parts of the code you looked at or tested. Approvals without comment or a single _LGTM_ are not useful and will be dismissed. \
-Some exceptions to this rule are e.g. approving a single line comment typo fix, though even than the review should say something along the lines of "LGTM as it's just single line typo fix in a comment". In a nutshell it should be obvious to a future reader why you approved a PR without the reader having to look at the file diff first.
+!!! warning
+    Approval reviews should **always** contain information about what parts of the code you looked at or tested. Approvals without comment or a single _LGTM_ are not useful and will be dismissed. \
+    Some exceptions to this rule are e.g. approving a single line comment typo fix, though even than the review should say something along the lines of "LGTM as it's just single line typo fix in a comment". In a nutshell it should be obvious to a future reader why you approved a PR without the reader having to look at the file diff first.
 
-Contributors with reviewer access may see their role removed should they leave (multiple) empty/_"LGTM"_ reviews.
+    Contributors with reviewer access may see their role removed should they leave (multiple) empty/_"LGTM"_ reviews.
+
+    If you want to "approve" a pull request because you like the feature it implements, please opt for simply giving the PR a "👍" reaction instead.
 
-If you want to "approve" a pull request because you like the feature it implements, please opt for simply giving the PR a "👍" reaction instead.
-{% endhint %}
 
 Finally, click on _"Submit review"_. Your review is now publicly visible, congrats! :D
diff --git a/docs/Wiki/development/testing.md b/docs/Wiki/development/testing.md
@@ -6,9 +6,9 @@ description: >-
 
 # Testing
 
-{% hint style="info" %}
-This section is very much still WIP. Feel free to help expand it.
-{% endhint %}
+!!! info
+    This section is very much still WIP. Feel free to help expand it.
+
 
 ## Developers & Contributors
 

diff --git a/docs/Wiki/hosting-a-server-with-northstar/dedicated-server/best-practices.md b/docs/Wiki/hosting-a-server-with-northstar/dedicated-server/best-practices.md
@@ -4,9 +4,9 @@ description: Tweaks and tricks to improve both your experience in hosting and ot
 
 # Best practices
 
-{% hint style="info" %}
-TODO: If you have experience in hosting Northstar servers and want to share your knowledge, please open a [pull request](https://github.com/R2Northstar/NorthstarWiki/pulls).
-{% endhint %}
+!!! info
+    TODO: If you have experience in hosting Northstar servers and want to share your knowledge, please open a [pull request](https://github.com/R2Northstar/NorthstarWiki/pulls).
+
 
 ## Optimization Commands (Optional)
 

diff --git a/docs/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md b/docs/Wiki/hosting-a-server-with-northstar/dedicated-server/hosting-on-linux.md
@@ -1,8 +1,8 @@
 # Hosting on Linux
 
-{% hint style="info" %}
-This page is currently work-in-progress.
-{% endhint %}
+!!! info
+    This page is currently work-in-progress.
+
 
 Linux users can launch the server executable using a Docker image or by using Wine.
 If you do not have a DirectX 11 capable GPU in your system (for example if you are using a hosting service), you will want to host a **Headless server.**

diff --git a/docs/Wiki/hosting-a-server-with-northstar/getting-started.md b/docs/Wiki/hosting-a-server-with-northstar/getting-started.md
@@ -4,10 +4,10 @@
 
 Make sure you already installed Northstar [as described here](../installing-northstar/basic-setup.md).
 
-{% hint style="warning" %}
-Hosting your own server of any kind requires basic knowledge of computer networks!\
-If you for example don't know what "port forwarding" means and just want to play private matches with your friends it is generally recommended to just find an empty public server instead of trying to host your own server.
-{% endhint %}
+!!! warning
+    Hosting your own server of any kind requires basic knowledge of computer networks!\
+    If you for example don't know what "port forwarding" means and just want to play private matches with your friends it is generally recommended to just find an empty public server instead of trying to host your own server.
+
 
 ## Check whether you can port forward
 

diff --git a/docs/Wiki/hosting-a-server-with-northstar/local-only-server.md b/docs/Wiki/hosting-a-server-with-northstar/local-only-server.md
@@ -5,12 +5,12 @@ If you just want to host server (listen or dedicated) for people in your local n
 This way players can connect to your server directly by using the `connect` command with the local IP of your server, e.g. `connect 192.168.420.500` (replace with actual local IP of your server).
 
 
-{% hint style="info" %}
-Loadouts are saved by the server and connecting to a server directly using `connect` means that the loadout is not loaded from masterserver. This means your loadouts will be reset while playing on said server.
+!!! info
+    Loadouts are saved by the server and connecting to a server directly using `connect` means that the loadout is not loaded from masterserver. This means your loadouts will be reset while playing on said server.
 
-You should see your saved loadouts again when leaving the local-only server
-{% endhint %}
+    You should see your saved loadouts again when leaving the local-only server
+
+
+!!! info
+    Even with local-only servers you still need an internet connection to authenticate your account and game ownership with masterserver.
 
-{% hint style="info" %}
-Even with local-only servers you still need an internet connection to authenticate your account and game ownership with masterserver.
-{% endhint %}
diff --git a/docs/Wiki/hosting-a-server-with-northstar/server-settings/playlistvar.md b/docs/Wiki/hosting-a-server-with-northstar/server-settings/playlistvar.md
@@ -1,11 +1,11 @@
 ### Playlist overrides
 
-{% hint style="warning" %}
-Playlist overrides determines the behaviour of the server. PlaylistOverrides can be added using the `+setplaylistvaroverrides` argument in the `ns_startup_args_dedi.txt` file.
+!!! warning
+    Playlist overrides determines the behaviour of the server. PlaylistOverrides can be added using the `+setplaylistvaroverrides` argument in the `ns_startup_args_dedi.txt` file.
 
 The list of playlist overrides needs to be quoted and separated by spaces.\
 Example: `+setplaylistvaroverrides "run_epilogue 0 featured_mode_amped_tacticals 1"`
-{% endhint %}
+
 
 | PlaylistOverrides                            | Accepted Values | Default Value | Description                                                                                                         |
 | -------------------------------------------- | --------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/Wiki/installing-northstar/troubleshooting.md b/docs/Wiki/installing-northstar/troubleshooting.md
@@ -207,9 +207,9 @@ Relevant issue on GitHub: [https://github.com/R2Northstar/Northstar/issues/284](
 
 ## I used a command to set my player/gun XP level and I set it too high so now my game crashes when trying to join multiplayer
 
-{% hint style="warning" %}
-The following command will reset all your loadouts and levels!
-{% endhint %}
+!!! warning
+    The following command will reset all your loadouts and levels!
+
 
 Open console in-game in main menu, type in `ns_resetpersistence` and press enter. Close console again and click on "Launch Northstar". All your stuff should now be reset.
 

diff --git a/docs/Wiki/other/moderation/README.md b/docs/Wiki/other/moderation/README.md
@@ -1,8 +1,8 @@
 # Moderation
 
-{% hint style="info" %}
-This page contains information targetted at Discord moderators.
-{% endhint %}
+!!! info
+    This page contains information targetted at Discord moderators.
+
 
 
 ## General stuff

diff --git a/docs/Wiki/steamdeck-and-linux/installing-on-steamdeck-and-linux.md b/docs/Wiki/steamdeck-and-linux/installing-on-steamdeck-and-linux.md
@@ -2,13 +2,13 @@
 
 ## Steam & Steam Deck (NorthstarProton)
 
-{% hint style="warning" %}
-EA App currently displays a blank screen when using NorthstarProton, however Northstar will still launch assuming you have logged in to EA App at least once.
-{% endhint %}
+!!! warning
+    EA App currently displays a blank screen when using NorthstarProton, however Northstar will still launch assuming you have logged in to EA App at least once.
+
+
+!!! warning
+    NorthstarProton has some problems and may stop working at any point, if this happens you can try [deleting the compatibility directory](linux-troubleshooting.md#northstar-not-launching-with-steam) or visit the Northstar Discord for help.
 
-{% hint style="warning" %}
-NorthstarProton has some problems and may stop working at any point, if this happens you can try [deleting the compatibility directory](linux-troubleshooting.md#northstar-not-launching-with-steam) or visit the Northstar Discord for help.
-{% endhint %}
 
 > **Check your GLIBC version.** NorthstarProton currently only supports version 2.33 and higher. Verify your installed version with `ldd --version`. **Ubuntu 20.04 LTS** and **Debian 11** are known to have outdated GLIBC packages, meaning you will have to experiment with finding a Proton version that works for you, or use Lutris. It is therefore strongly recommended to use an up-to-date Linux distro to be able to make use of NorthstarProton. This check does not need to be completed on Steam Deck or Steam OS.
 
@@ -38,10 +38,10 @@ On Steam Deck, complete the following in desktop mode. You may return to game mo
 
 Note that removing the `%command% -northstar` will cause Steam to launch the vanilla game again.
 
-{% hint style="info" %}
-This guide assumes you're *up to date with NorthstarProton*, as the method used to launch Northstar changed in NorthstarProton-8.1-1 which was released on 2023-02-22.\
-If you're using an older version of NorthstarProton, replace the information about launch options with a text file called `run_northstar.txt` in your Titanfall2 directory. This text file should have a single character `1` inside.
-{% endhint %}
+!!! info
+    This guide assumes you're *up to date with NorthstarProton*, as the method used to launch Northstar changed in NorthstarProton-8.1-1 which was released on 2023-02-22.\
+    If you're using an older version of NorthstarProton, replace the information about launch options with a text file called `run_northstar.txt` in your Titanfall2 directory. This text file should have a single character `1` inside.
+
 
 ## Lutris (Wine)
 

diff --git a/docs/Wiki/steamdeck-and-linux/linux-troubleshooting.md b/docs/Wiki/steamdeck-and-linux/linux-troubleshooting.md
@@ -142,9 +142,9 @@ If you ever used ReShade together with Titanfall2 in the past it will have creat
 
 ## Archive
 
-{% hint style="info" %}
-The following issues should no longer occur in the latest Northstar releases.
-{% endhint %}
+!!! info
+    The following issues should no longer occur in the latest Northstar releases.
+
 
 ### Blank console
 

diff --git a/docs/Wiki/using-northstar/advanced.md b/docs/Wiki/using-northstar/advanced.md
@@ -1,8 +1,8 @@
 # Advanced Options
 
-{% hint style="warning" %}
-This is a section detailing the more advanced parts of using Northstar, with some of them having a chance to potentially mess with your game. Setting your level too high, for example, will lock you out of Northstar's multiplayer until you reset your entire player stats, progress, and loadouts.
-{% endhint %}
+!!! warning
+    This is a section detailing the more advanced parts of using Northstar, with some of them having a chance to potentially mess with your game. Setting your level too high, for example, will lock you out of Northstar's multiplayer until you reset your entire player stats, progress, and loadouts.
+
 
 ## Mod profiles <a href="#profiles" id="profiles"></a>
 
@@ -23,9 +23,9 @@ You can set up profiles in an even more advanced way by setting up a way to use
 
 ## Setting levels using console commands <a href="#set-level" id="set-level"></a>
 
-{% hint style="warning" %}
-This section can cause you to mess up your persistence (multiplayer user data) on Northstar if you set your levels too high! Make sure to read carefully!
-{% endhint %}
+!!! warning
+    This section can cause you to mess up your persistence (multiplayer user data) on Northstar if you set your levels too high! Make sure to read carefully!
+
 
 With everything unlocked, there is no need to set your level to a higher level, but some users may still want to do so. In order to this, you'll need to open the in-game console with the `~` button on your keyboard and type in/copy and paste the relevant commands. Both of these require `sv_cheats 1` to be enabled on the server you're playing on, easily done by using `sv_cheats 1` in the console in a private match.
 

diff --git a/docs/Wiki/using-northstar/commands.md b/docs/Wiki/using-northstar/commands.md
@@ -10,9 +10,9 @@ If you for example have a German keyboard you'll notice that this key is located
 To open your console you'll either have to switch to the English (US) layout **before** starting the game or rebinding the key to open console.
 
 ### Rebinding the console
-{% hint style="info" %}
-The console can only be bound to ```"`"``` or one of the function keys ```"F1" - "F12"```
-{% endhint %}
+!!! info
+    The console can only be bound to ```"`"``` or one of the function keys ```"F1" - "F12"```
+
 
 To rebind it open Titanfall and navigate to `Controls > Settings > Key Binds` and change the `"Toggle Developer Console"` bind.
 

diff --git a/docs/Wiki/using-northstar/gamemodes.md b/docs/Wiki/using-northstar/gamemodes.md
@@ -2,9 +2,9 @@
 
 Northstar comes included with some community made gamemodes.
 
-{% hint style="info" %}
-If you are looking for every available gamemode and its corresponding string check [hosting/gamemodes](../hosting-a-server-with-northstar/server-settings/file-names.md)
-{% endhint %}
+!!! info
+    If you are looking for every available gamemode and its corresponding string check [hosting/gamemodes](../hosting-a-server-with-northstar/server-settings/file-names.md)
+
 
 ## Gun Game