GroovyScript Improvements (#12)

* change mclang to ini for highlighting
* fix Fluid typo
* fix codeblock rendering in events/index.md
* speed up details animation
* increase the page size
* add introduction page
* move external compat and getting started to introduction
* fix file paths
* collapse sidebar tabs by default
* order sidebar tabs

* add main page to sidebar as root tab

* move warning to top of page

* add editors.md for the language server

* convert introduction into getting started

* list all valid extensions

* move run config into separate file

* run config packmode

* add `init` phase, intent

* introduction index links to pages

* add reloading page for reloading information

* use mind control on tsconfig to make it like me

* use headers for run_config

* move run-config related info to run_config

* word reload options better

* fix links pointing to moved file

* remove Familiarity since thats been gone for year+

* add Object Mappers page

* remove duplicate explicit title

* move GrS specific info from Groovy to Introduction

* tweak builder file

* fix page change breaking on index files and root

* explain basic operations more extensively

* list modifications to Groovy GrS makes, add preprocessors

* fix grammar and typo errors

* improve log description

* adjust ordering

* document classes array not object

* add classes file

* cleanup readme

* rename introduction folder to getting_started

* fix index file being included twice

* specify version and bug for classes package warning

* correct misinformation about when editor starts up

* correct misinformation about where groovy.log is

* correct preprocessor information

* fix some assignment operators

* add lists category and fix issues in differences from java

* add headers to strings page

* fix run_config issues from review

* basics whitespace adjustment

* remove incorrect class caching information

* improve groovy.log documentation

* adjust link in run_config to point to new location

* adjust reloading example to actually work

* remove udplicates in operator overloading

* reload by event

Author: WaitingIdly

README.md

@@ -2,17 +2,20 @@
 
 This is where the entire site is stored, and to keep the repository tidy, please contribute as follows.
 
-## How to contribute
+## How to Contribute
+
+1. Clone the GitHub.
+2. Install [`pnpm`](https://pnpm.io/).
+3. Run `pnpm i` on the project to download the required development dependencies to `node_modules`.
+4. Run `pnpm dev` to launch the localhost server.
+5. Run `pnpm build` to confirm that all links are valid.
+6. Thank you for contributing!
 
-1. Setup project
 
-```sh
-pnpm i
-```
 
-For develop server, run `pnpm dev`.
+### Optional Steps
 
-2. Setup cz-git
+Setup cz-git
 
 If you don't know what this is, check out [here](https://cz-git.qbb.sh/guide/#as-global-use).
 
@@ -31,29 +34,3 @@ replace ~/.czrc to
     "markBreakingChangeMode": true
 }
 ```
-
-3. Additional Formats
-
-- DropDown
-
-```markdown
-// after frontmatter
-<script lang="ts" setup>
-import DropDown from "../../components/DropDown.vue"
-</script>
-
-// something
-
-<DropDown>
-<template #label>
-
-`replaceByName()`
-
-</template>
-<template #content>
-
-See the [Crafting page](https://groovyscript-docs.readthedocs.io/en/latest/groovyscript/minecraft/crafting/) for details about these.
-
-</template>
-</DropDown>
-```

components/internal/CustomDocFooter.vue

@@ -22,13 +22,13 @@ function shouldOperateChangeTabKeybind() {
 onKeyStroke([",", "ArrowLeft"], (e) => {
     if (!shouldOperateChangeTabKeybind()) return
     e.preventDefault()
-    if (control.value.prev?.link) router.go(control.value.prev.link)
+    if (control.value.prev?.link) router.go(control.value.prev.link.replace(/\.md$/, ''))
 });
 
 onKeyStroke([".", "ArrowRight"], (e) => {
     if (!shouldOperateChangeTabKeybind()) return
     e.preventDefault()
-    if (control.value.next?.link) router.go(control.value.next?.link)
+    if (control.value.next?.link) router.go(control.value.next.link.replace(/\.md$/, ''))
 });
 
 </script>

docs/.vitepress/config/en.ts

@@ -13,10 +13,15 @@ const sidebar = generateSidebar([
     keepMarkdownSyntaxFromTitle: true,
     useTitleFromFrontmatter: true,
     useTitleFromFileHeading: true,
-    sortMenusByName: true,
+    sortMenusByFrontmatterOrder: true,
+    sortMenusOrderByDescending: true,
+    collapsed: true,
     collapseDepth: 2,
     folderLinkNotIncludesFileName: true,
     useFolderLinkFromIndexFile: true,
+    rootGroupText: 'GroovyScript',
+    rootGroupLink: '.',
+    rootGroupCollapsed: false,
   }
 ]);
 

docs/.vitepress/theme/composables/details.ts

@@ -1,4 +1,4 @@
-const EXPAND_DETAILS_ANIMATION_DURATION = 250
+const EXPAND_DETAILS_ANIMATION_DURATION = 50
 
 export function handleDetailsAnimation(details: HTMLDetailsElement) {
   let animation: Animation | undefined

docs/.vitepress/theme/style.css

@@ -3,6 +3,23 @@
  * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
  */
 
+
+/**
+ * Page Size
+ *
+ * Increases the page size so that there isn't large dead space on the sides
+ * of larger monitors.
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-layout-max-width: 100%
+}
+
+.VPDoc.has-aside .content-container {
+  max-width: 95% !important;
+}
+
+
 /**
  * Colors
  *

docs/groovy-script/content/block.md

@@ -48,7 +48,7 @@ content.createBlock('dust_block')
 Let's assume that the pack id is `nomifactory` so that the item and block id will be `nomifactory:dust_block`.
 Insert this line into the lang file.
 
-```mclang:no-line-numbers
+```ini:no-line-numbers
 tile.nomifactory.dust_block.name=Heart of the universe
 ```
 

docs/groovy-script/content/fluid.md

@@ -60,7 +60,7 @@ The example above creates a simple fluid for you, but you can also create fluids
 Use the following methods to register custom fluids.
 
 ```groovy:no-line-numbers
-content.registerFluid(Fluis)
+content.registerFluid(Fluid)
 ```
 
 ::: info Warning {id="warning"}
@@ -77,6 +77,6 @@ If a fluid has a block the block state json is automatically generated,
 Add `fluid.[pack id].[fluid name]=Fluid Name` to your lang file
 
 Example for molten iron:
-```mclang:no-line-numbers
+```ini:no-line-numbers
 fluid.placeholdername.molten_iron=Molten Iron
 ```

docs/groovy-script/content/index.md

@@ -6,8 +6,8 @@ for CraftTweaker, but for GroovyScript it doesn't require another mod.
 ::: info Warning {id="warning"}
 Requires version 0.4.0+. <br>
 Before you start adding content make sure to specify the pack name and id in
-your [runConfig](../getting_started.md#run-config). <br>
-Also make sure to read [pack name and id](../getting_started.md#pack-name-and-id)
+your [runConfig](../getting_started/index.md#run-config). <br>
+Also make sure to read [pack name](../getting_started/run_config.md#packname) and [id](../getting_started/run_config.md#packid)
 :::
 
 Currently, GroovyScript adds helpers to create

docs/groovy-script/content/item.md

@@ -1,3 +1,7 @@
+---
+order: 1000
+---
+
 # Creating items
 
 ## The simplest way
@@ -47,7 +51,7 @@ the lang file. GroovyScript generates a default lang file at `.minecraft/groovy/
   Let's assume that the pack id is `nomifactory` so that the item id will be `nomifactory:heart_of_the_universe`.
   Insert this line into the lang file.
 
-  ```mclang:no-line-numbers
+  ```ini:no-line-numbers
   item.nomifactory.heart_of_the_universe.name=Heart of the universe
   ```