Merge pull request #31 from RappyTV/master

Several improvements

Author: einrobin

.github/workflows/ci.yml

@@ -1,8 +1,10 @@
 name: ci
+
 on:
   push:
     branches:
       - master
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
@@ -11,6 +13,7 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material
-      - run: pip install mkdocs-include-dir-to-nav
-      - run: mkdocs gh-deploy --force
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Deploy docs
+        run: mkdocs gh-deploy --force

.gitignore

@@ -1,4 +1,5 @@
 *.iml
 .idea/*
 .vscode/*
+.venv
 site/*

README.md

@@ -1,8 +1,55 @@
-# LabyMod4 API Wiki
+# LabyMod 4 API Wiki
 
-This is the official wiki for the LabyMod 4 API.
+This is the official wiki for the **LabyMod 4 API**.
+It contains guides, documentation, and examples on how to use and extend the API.
 
-Have you found something missing from this wiki that you think is important, or are you unhappy with something? 
-Please fork this repository, add/improve it and create a pull request.
+## Contributing
 
-The live build can be found <a href="https://dev.labymod.net" target="_blank">here</a>.
+Have you found something missing from this wiki that you think is important, or are you unhappy with something?
+We welcome contributions! Simply fork this repository, add or improve the content, and then open a pull request.
+
+Please make sure your changes are clear, well-formatted, and accurate before submitting.
+
+## Live Build
+
+The live version of this wiki can be found [here](https://dev.labymod.net).
+
+## Preview Locally
+
+To run the wiki locally, follow these steps:
+
+### Requirements
+- [Python](https://www.python.org/downloads/) (3.8 or higher recommended)
+- [pip](https://pip.pypa.io/en/stable/)
+
+### Setup
+
+1. **Create a virtual environment**
+
+   ```bash
+   python -m venv .venv
+   ```
+
+2. **Activate the virtual environment**
+
+   ```bash
+   # Windows (cmd)
+   .venv\Scripts\activate.bat
+
+   # macOS / Linux
+   source .venv/bin/activate
+   ```
+
+3. **Install dependencies**
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. **Start the development server**
+
+   ```bash
+   mkdocs serve
+   ```
+
+   The wiki will now be available at http://127.0.0.1:8000.

docs/assets/files/screenshots/config-revision.gif

@@ -3,7 +3,7 @@ Only if you want to display something truly custom, knowing OpenGL could be bene
 
 In the following pages, we will explain how to create custom activities, create and use widgets in your Activities, and theme them with LSS. It can be a bit much to take in at first, but it's worth it.
 
-Examples are shown on every page; you will find a link to the section with the example on every page within the first paragraphs. Click <a href="#bare-activity-example">here</a> to see the first example.
+Examples are shown on every page; you will find a link to the section with the example on every page within the first paragraphs. Click [here](#bare-activity-result) to see the first example.
 
 ???+ warning "Important Note"
 
@@ -50,4 +50,4 @@ Looking back at what we just wrote, this is what the code and result would look
     ```
 
 === ":octicons-file-media-24: Result"
-    ![Config-Result](/assets/files/screenshots/bare-activity-example.png)
+    ![Config-Result](../../../assets/files/screenshots/bare-activity-example.png)

docs/pages/addon/activities/activity.md

@@ -177,4 +177,4 @@ you can do it in the Activity.
     ```
 
 === ":octicons-file-media-24: Result"
-    ![Custom-Widget-Result](/assets/files/screenshots/lss-custom-widget-example.png)
+    ![Custom-Widget-Result](../../../assets/files/screenshots/lss-custom-widget-example.png)

docs/pages/addon/activities/custom-widgets.md

@@ -4,7 +4,7 @@ We have implemented LSS as a system to design and theme responsive GUIs (Screens
 ## LSS in a Nutshell
 
 The main thing you need to know about LSS is that while you add LSS StyleSheets to your Activity, you can't manipulate Activities directly, only the Widgets inside of that Activity. 
-A list of all Widgets delivered with the API can be found <a href="#FINAL-LINK-HERE">here</a>.
+A list of all Widgets delivered with the API can be found [here](widgets.md#all-widgets).
 
 CSS and LSS have very similar syntax, but here are some of their differences:
 
@@ -15,7 +15,7 @@ CSS and LSS have very similar syntax, but here are some of their differences:
 
 ## Creating Activities with LSS
 
-Looking back at <a href="#FINAL-LINK-HERE">the last page</a>, we created an Activity with a ComponentWidget but without LSS. 
+Looking back at [the last page](custom-widgets.md), we created an Activity with a ComponentWidget but without LSS. 
 We'll again use the last page's result to make it work with LSS.
 
 We start by deleting the `postStyleSheetLoad` method, which we used before to set the position of our Widget. 
@@ -75,7 +75,7 @@ Like before, this is what the code we described above would look like:
     ```
 
 === ":octicons-file-media-24: Result"
-    ![Config-Result](/assets/files/screenshots/lss-activity-example.png)
+    ![Config-Result](../../../assets/files/screenshots/lss-activity-example.png)
 
 
 ## Injecting Blocks Into Other StyleSheets

docs/pages/addon/activities/lss.md

@@ -35,7 +35,7 @@ simply taken from its parent.
 Besides any other file in your `assets/<my namespace>` folder there are also theme files located
 in `assets/<my namespace>/themes/<theme>` with the following structure:
 
-![Theme-File-Tree](/assets/files/screenshots/theme-file-structure.png)
+![Theme-File-Tree](../../../assets/files/screenshots/theme-file-structure.png)
 
 Usually you don't need to access these files directly because LabyMod handles it for stuff like LSS stylesheets,
 icons in the settings and hud widgets. If you still need to access a ThemeFile, it works like this:
@@ -49,7 +49,7 @@ public ResourceLocation getThemeResource() {
 
 ## Implement an existing theme in your addon
 
-Coming from [Understand LSS](/pages/addon/activities/lss) you already know how to create LSS stylesheets for the
+Coming from [Understand LSS](lss.md) you already know how to create LSS stylesheets for the
 vanilla theme by putting them in `assets/example/themes/vanilla/lss/`. When implementing the fancy theme, you now want
 to put your new LSS stylesheets in `assets/example/themes/fancy/lss/` and name them exactly the same.
 

docs/pages/addon/activities/themes.md

@@ -2,7 +2,7 @@ Widgets are a valuable and easy way to customize your Activities and are the bac
 
 ## Use Widgets in Activities
 
-This part will show you how to use and integrate Widgets into your Activity. Looking back at our bare Activity example, we rendered the text `"I am a bare rendered example text"`, so we'll be using a ComponentWidget just this time with the text `"I am an example text rendered with a ComponentWidget"`. We're building onto the code from the previous example so if you haven't already gone through it, we recommend taking a look at it <a href="/pages/addon/activities/activity/">here</a>.
+This part will show you how to use and integrate Widgets into your Activity. Looking back at our bare Activity example, we rendered the text `"I am a bare rendered example text"`, so we'll be using a ComponentWidget just this time with the text `"I am an example text rendered with a ComponentWidget"`. We're building onto the code from the previous example so if you haven't already gone through it, we recommend taking a look at it [here](activity.md).
 
 ???+ warning "Important Note"
 
@@ -56,13 +56,13 @@ Like with the bare Activity, this is what the code we described above would look
     ```
 
 === ":octicons-file-media-24: Result"
-    ![Config-Result](/assets/files/screenshots/widget-activity-example.png)
+    ![Activity-Result](../../../assets/files/screenshots/widget-activity-example.png)
 
 ## All Widgets
 
 Below listed are all Widgets for use. They can be extended and modified for a more specific use case. <br>
 
-Every Widget also has the LSS Properties from <a href="#abstract-widget">`AbstractWidget`</a>
+Every Widget also has the LSS Properties from [`AbstractWidget`](#abstract-widget)
 
 ???+ warning "Important Note"
 
@@ -78,8 +78,8 @@ The `ButtonWidget` is an Input-Widget that performs a specific action (set with
 It can be created with a String with `ButtonWidget.text` and a Component with `ButtonWidget.component`. <br>
 The Widget has the following LSS properties: 
 
-  + Everything from <a href="#FINAL-LINK-HERE">`HorizontalListWidget`</a> (because the Button can have an Icon)
-  + icon 
+  + Everything from [`HorizontalListWidget`](#horizontal-list) (because the Button can have an Icon)
+  + icon
 
 #### Check Box
 
@@ -107,13 +107,13 @@ The Widget has no own LSS properties.
 The `KeybindWidget` is an Input-Widget that allows the user to set a specific Key. 
 It also accepts mouse buttons when expressly set with `acceptMouseButtons(Boolean)`.
 It can be created via its constructor. <br>
-The Widget has the same LSS properties as <a href="#text-field">`TextFieldWidget`</a>.
+The Widget has the same LSS properties as [`TextFieldWidget`](#text-field).
 
 #### Multi Keybind
 
 The `MultiKeybindWidget` is an Input-Widget that allows users to set multiple keys simultaneously. 
 It can be created via its constructor. <br>
-The Widget has the same LSS properties as <a href="#text-field">`TextFieldWidget`</a>.
+The Widget has the same LSS properties as [`TextFieldWidget`](#text-field).
 
 #### Slider
 

docs/pages/addon/activities/widgets.md

@@ -2,6 +2,9 @@
 
 With LabyMod 4, you can easily create custom client-side commands. This page will show you how.
 
+???+ info "Command suggestions"
+    Command suggestions are not yet supported. This means that commands will not appear as valid suggestions in the chat. However, you can still enter and execute them normally. Support for command suggestions may be added in the future.
+
 ### The Super Method
 The first parameter in the super constructor call is the prefix, see it as the name of your command. Every parameter after is an alias and thus optional.
 
@@ -11,7 +14,7 @@ The execute method contains the code that is executed if the player is using you
 Before you're able to use and test your command in-game, you'll need to register the command by calling  `this.registerCommand(new ExampleCommand());` in your main class. You don't need to do anything else, after registering the command and restarting LabyMod you can submit "/notify" or "/alias" in the ingame-chat and your command will be executed.
 
 ### Subcommands
-You can also add subcommands to your command. To do so, you'll need to create a new class that inherits from `SubCommand` and add it to your command by calling `this.withSubCommand(new ExampleSubCommand());` in your command's constructor. You can set the sub command's name and aliases the same way you set the command's name with the <a href="#the-super-method">super</a> constructor call.
+You can also add subcommands to your command. To do so, you'll need to create a new class that inherits from `SubCommand` and add it to your command by calling `this.withSubCommand(new ExampleSubCommand());` in your command's constructor. You can set the sub command's name and aliases the same way you set the command's name with the [super](#the-super-method) constructor call.
 
 === ":octicons-file-code-16: ExampleCommand"
     ```java