update docs css and other issues

lumin-org · Jun 11, 2024 · 6dd7ef9 · 6dd7ef9
1 parent 8cb5215
commit 6dd7ef9
Show file tree

Hide file tree

Showing 13 changed files with 61 additions and 43 deletions.
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -0,0 +1,17 @@
+@import url('https://fonts.googleapis.com/css2?family=Inter:[email protected]&display=swap');
+
+:root {
+	--vp-c-bg: #e6e6e6;
+	--vp-c-bg-alt: #d2d2d2;
+	--vp-c-brand-1: #4da134;
+	--vp-c-brand-2: #69a856;
+	--vp-c-brand-3: #75b861;
+}
+
+.dark {
+	--vp-c-bg: #121212;
+	--vp-c-bg-alt: #161616;
+	--vp-c-brand-1: #8fda78;
+	--vp-c-brand-2: #69a856;
+	--vp-c-brand-3: #75b861;
+}
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -1,7 +1,7 @@
 // https://vitepress.dev/guide/custom-theme
 import { h } from 'vue'
 import Theme from 'vitepress/theme'
-import './style.css'
+import './custom.css'
 
 export default {
   extends: Theme,

diff --git a/docs/api/client.md b/docs/api/client.md
@@ -4,31 +4,31 @@ The framework's client-sided interface.
 
 ## Properties
 
-### Player <Badge type="tip" text="read only" />
+### `Player` <Badge type="tip" text="read only" />
 
 A simple reference to the [Players.LocalPlayer](https://create.roblox.com/docs/reference/engine/classes/Players#LocalPlayer)
 
 * [**Player**](https://create.roblox.com/docs/reference/engine/classes/Player)
 
 ---
 
-### PlayerGui <Badge type="tip" text="read only" />
+### `PlayerGui` <Badge type="tip" text="read only" />
 
 A simple reference to the [Player.PlayerGui](https://create.roblox.com/docs/reference/engine/classes/Player#PlayerGui)
 
 * [**PlayerGui**](https://create.roblox.com/docs/reference/engine/classes/PlayerGui)
 
 ---
 
-### Network <Badge type="tip" text="read only" />
+### `Network` <Badge type="tip" text="read only" />
 
 A simple reference to the network contstructor.
 
 * [**Network**](/api/network/)
 
 ## Functions
 
-### Character
+### `Character`
 
 Gets the players current character model; if it doesn't exist the thread will yield until it does.
 

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -1,18 +1,18 @@
-# LuminFramework (Root)
+# LuminFramework
 
 The main class of LuminFramework.
 
 ## Properties
 
-### Promise <Badge type="tip" text="read only" />
+### `Promise` <Badge type="tip" text="read only" />
 
 A reference to evaera's Promise module.
 
 * [**Promise**](https://eryn.io/roblox-lua-promise/)
 
 ## Functions
 
-### Server <Badge type="danger" text="server" />
+### `Server` <Badge type="danger" text="server" />
 
 Gets the server-sided interface of LuminFramework.
 
@@ -22,7 +22,7 @@ Gets the server-sided interface of LuminFramework.
 
 ---
 
-### Client <Badge type="danger" text="client" /> <Badge type="warning" text="yields" />
+### `Client` <Badge type="danger" text="client" /> <Badge type="warning" text="yields" />
 
 Gets the client-sided interface of LuminFramework.
 
@@ -32,7 +32,7 @@ Gets the client-sided interface of LuminFramework.
 
 ---
 
-### Load
+### `Load`
 
 Imports any modules of the parent provided. Non-modules will be filtered out automatically.
 
@@ -50,7 +50,7 @@ Allows you to filter through a module, return `false` for it to not be imported
 
 ---
 
-### Signal
+### `Signal`
 
 Creates/references a signal of the given name, create a new anonymous signal by leaving the name blank.
 

diff --git a/docs/api/network/client/event.md b/docs/api/network/client/event.md
@@ -4,15 +4,15 @@ A client-sided network event.
 
 ## Properties
 
-### Reliable <Badge type="tip" text="read only" />
+### `Reliable` <Badge type="tip" text="read only" />
 
 Whether or not the network event uses a reliable remote event.
 
 * **boolean**
 
 ## Methods
 
-### Fire
+### `Fire`
 
 Fires an event which sends data to the server, equivalent to [RemoteEvent:FireServer](https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireServer)
 
@@ -27,7 +27,7 @@ The data that should be sent to the server
 
 ---
 
-### FireNow
+### `FireNow`
 
 Same as `Fire` but does not batch the call / wait until the next frame
 
@@ -42,7 +42,7 @@ The data that should be sent to the server
 
 ---
 
-### Listen
+### `Listen`
 
 Listens for the network controller to be fired by the server, then runs the provided function. Note that this can only be run once, it will error if run more than once.
 

diff --git a/docs/api/network/client/function.md b/docs/api/network/client/function.md
@@ -4,15 +4,15 @@ A client-sided network function.
 
 ## Properties
 
-### Reliable <Badge type="tip" text="read only" />
+### `Reliable` <Badge type="tip" text="read only" />
 
 Whether or not the network function uses a reliable remote event.
 
 * **boolean**
 
 ## Methods
 
-### InvokeAsync
+### `InvokeAsync`
 
 Invokes the server, equivalent to [RemoteFunction:InvokeServer](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#InvokeServer). Returns a future (promise).
 

diff --git a/docs/api/network/index.md b/docs/api/network/index.md
@@ -4,7 +4,7 @@ The library to create network events and functions.
 
 ## Functions
 
-### Event
+### `Event`
 
 The contstructor for creating new network events.
 
@@ -22,7 +22,7 @@ Whether or not the object created is reliable. Defaults to true
 
 ---
 
-### Function
+### `Function`
 
 The contstructor for creating new network functions.
 

diff --git a/docs/api/network/server/event.md b/docs/api/network/server/event.md
@@ -4,15 +4,15 @@ A server-sided network event.
 
 ## Properties
 
-### Reliable <Badge type="tip" text="read only" />
+### `Reliable` <Badge type="tip" text="read only" />
 
 Whether or not the network event uses a reliable remote event.
 
 * **boolean**
 
 ## Methods
 
-### Fire
+### `Fire`
 
 Fires an event which sends data to the client, equivalent to [RemoteEvent:FireClient](https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireClient).
 
@@ -38,7 +38,7 @@ The data that should be sent to the client
 
 ---
 
-### FireNow
+### `FireNow`
 
 Same as `Fire` but does not batch the call / wait until the next frame
 
@@ -56,7 +56,7 @@ The data that should be sent to the client
 
 ---
 
-### FireAll
+### `FireAll`
 
 Fires an event which sends data to every client connected to the server, equivalent [RemoteEvent:FireAllClients](https://create.roblox.com/docs/reference/engine/classes/RemoteEvent#FireAllClients).
 
@@ -71,7 +71,7 @@ The data that should be sent to each player
 
 ---
 
-### FireExcept
+### `FireExcept`
 
 Fires an event which sends data to every client connected to the server, except for players defined in the `except` parameter.
 
@@ -89,7 +89,7 @@ The data that should be sent to each player except `except`
 
 ---
 
-### FireFilter
+### `FireFilter`
 
 Fires an event with a filter function, and runs the provided filter on every player in the server.
 
@@ -107,7 +107,7 @@ The data that should be sent to each player that meets the threshold for `filter
 
 ---
 
-### Listen
+### `Listen`
 
 Listens for the network controller to be fired by the client, then runs the provided function.
 
@@ -125,7 +125,7 @@ A table of the valid types that should be recieved by the client. This is option
 
 ---
 
-### SetRateLimit
+### `SetRateLimit`
 
 Sets a rate limit that is applied when firing a network event from the client.
 

diff --git a/docs/api/network/server/function.md b/docs/api/network/server/function.md
@@ -4,15 +4,15 @@ A server-sided network function.
 
 ## Properties
 
-### Reliable <Badge type="tip" text="read only" />
+### `Reliable` <Badge type="tip" text="read only" />
 
 Whether or not the network function uses a reliable remote event.
 
 * **boolean**
 
 ## Methods
 
-### OnInvoke
+### `OnInvoke`
 
 Recieves an invoke from the client, and runs the callback function which returns some data. Equivalent to [RemoteFunction.OnServerInvoke](https://create.roblox.com/docs/reference/engine/classes/RemoteFunction#OnServerInvoke).
 
@@ -27,7 +27,7 @@ The callback function to run on invoke, must return at least 1 value.
 
 ---
 
-### SetRateLimit
+### `SetRateLimit`
 
 Sets a rate limit that is applied when invoking the network function from the client.
 

diff --git a/docs/api/server.md b/docs/api/server.md
@@ -4,7 +4,7 @@ The framework's server-sided interface.
 
 ## Properties
 
-### Network <Badge type="tip" text="read only" />
+### `Network` <Badge type="tip" text="read only" />
 
 A simple reference to the network contstructor.
 

diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -33,8 +33,8 @@ From here, you can access run context specific items like the player gui.
 
 To start a successful project, we recommend using:
 
-`jsdotlua/react-lua`
-`jsdotlua/react-roblox`
+`jsdotlua/react-lua`\
+`jsdotlua/react-roblox`\
 `sleitnick/trove`
 
 ... and of course Lumin Framework.
diff --git a/docs/index.md b/docs/index.md
@@ -7,20 +7,21 @@ hero:
   tagline: A lightning fast & amazing game framework
   actions:
     - theme: brand
-      text: Documentation
+      text: Guide
       link: /guides/
     - theme: alt
       text: API Reference
       link: /api/
 
 features:
-  - icon:
-      src: https://avatars.githubusercontent.com/u/118916772?v=4
-    title: AridAjd, 4.5⭐
-    details: <i>'Using the framework, you literally have no worries. The internal is heavily type-checked and also gives you the ability to keep your code to be strict on types. No bloat, lightweight on performance, straightforward API and does proper implementation of promises to improve development experience. Overall, a solid framework!'</i>
-  - icon: 
-      src: https://avatars.githubusercontent.com/u/110689336?v=4
-    title: GameboyTheDev, 4⭐
-    details: <i>'Lumin Framework is the best I have seen so far in making networking as simple and straightforward as possible! No need for having to create, locate and store remotes to network as Lumin Framework handles all of that for you! Makes the development process more convenient and fun to work with! Would recommend!'</i>
+  - icon: ⚡
+    title: Efficient
+    details: Does nothing else in the background and allocates as much resources as possible to more important jobs
+  - icon: 🦺
+    title: Strict typing
+    details: Everything is strictly typed internally, which means that it is less error prone and more reliable
+  - icon: 🎨
+    title: Customizable
+    details: Allows for any programming configuration, architecture, and allows for more customizable networking
 ---
 
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,6 +1,6 @@
 # Installation
 
-### GitHub
+### GitHub / Roblox
 
 1. Navigate to the latest release of Lumin Framework on [GitHub](https://github.com/lumin-dev/LuminFramework/releases/)
 2. Download `Standalone.rbxm`