Improve Documentation Site (#41)

* update css and snippets

* Add banner

* improve home page

* Update Banner

* cleanup

* Update font to JetBrains Mono

* Add a quick look to Home

* Simplify Home Page

* Removed banner, removed copyright notice, reduced home page
This commit is contained in:
alicesaidhi 2024-11-03 18:32:19 +01:00 committed by GitHub
parent f7dac3f63a
commit f8e84f9f8d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
29 changed files with 255 additions and 184 deletions

View file

@ -8,7 +8,7 @@ Shows one of two components depending on an input source.
- **Type**
```lua
```luau
function show<T>(source: () -> unknown, component: () -> T): () -> T?
function show<T, U>(source: () -> unknown, component: () -> T, fallback: () -> U): () -> T | U
```
@ -32,7 +32,7 @@ Shows one of a set of components depending on an input source and a mapping tabl
- **Type**
```lua
```luau
function switch<K, V>(source: () -> K): (map: Map<K, () -> V>) -> V?
```
@ -49,7 +49,7 @@ Shows one of a set of components depending on an input source and a mapping tabl
- **Example**
```lua
```luau
local logged = source(false)
local button = switch(logged) {
@ -69,7 +69,7 @@ Maps each index in a table source to an object.
- **Type**
```lua
```luau
function indexes<KI, VI, VO>(
source: () -> Map<KI, VI>,
transform: (value: () -> VI, index: KI) -> VO
@ -102,7 +102,7 @@ Maps each index in a table source to an object.
The intended purpose of this function is to map each index in a table to
a UI element.
```lua
```luau
type Item = {
name: string,
icon: number
@ -129,7 +129,7 @@ Maps each value in a table source to an object.
- **Type**
```lua
```luau
function values<KI, VI, VO>(
source: () -> Map<KI, VI>,
transform: (value: VI, index: () -> KI) -> VO
@ -169,7 +169,7 @@ Maps each value in a table source to an object.
The intended purpose of this function is to map each value in a table to
a UI element.
```lua
```luau
type Item = {
name: string,
icon: number