Additions 2023 11 20 (#8)

* chore: add link admonition type

* add links to kjs integration source code

* add WIP warning on home page

* slight rewording

CONTRIBUTING.md

@@ -73,6 +73,7 @@ Use [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admoniti
   - Use collapsible blocks (`??? example "my example title"` instead of `!!!`) for code examples where possible.  
     _In some situations this might not be as useful as using a non-collapsible block. Just fall back to `!!!` in these cases._
 - For pages or sections that are not documented yet, use `!!! failure "Not yet documented"`
+- For links, use the (custom) `link` type.
 
 We suggest adding an empty line after the title for consistency, like in the following example.  
 It is **strongly recommended** to include a custom, descriptive title for your admonition, if possible.

docs/Modpacks/KubeJS/Beyond-The-Docs.md

@@ -0,0 +1,30 @@
+---
+title: Beyond the Docs
+---
+
+
+# Beyond the Docs
+
+While we try to keep this documentation up to date and as complete as possible, it may not always contain all of the latest information.
+
+As an additional resource to these docs, you can also reference our KubeJS integration directly in the source code:  
+https://github.com/GregTechCEu/GregTech-Modern/tree/1.20.1/common/src/main/java/com/gregtechceu/gtceu/integration/kjs
+
+Continue reading for a few important places you may want to check.
+
+
+## Builders
+
+!!! link "Builders"
+    https://github.com/GregTechCEu/GregTech-Modern/tree/1.20.1/common/src/main/java/com/gregtechceu/gtceu/integration/kjs/builders
+
+If you're not sure what methods and fields are available on one of our builders, you can find all of them in this directory.
+
+
+## Bindings & Type Wrappers
+
+!!! link "GregTechKubeJSPlugin"
+    https://github.com/GregTechCEu/GregTech-Modern/blob/1.20.1/common/src/main/java/com/gregtechceu/gtceu/integration/kjs/GregTechKubeJSPlugin.java
+
+- For a list of our custom bindings, see `GregTechKubeJSPlugin.registerBindings()`
+- For a list of our type wrappers and their accepted inputs, see `GregTechKubeJSPlugin.registerTypeWrappers()`

docs/Modpacks/KubeJS/index.md

@@ -6,4 +6,11 @@ title: KubeJS Integration
 # KubeJS Integration
 
 GTCEu Modern offers extensive integration with KubeJS for customizability.  
-Refer to this section for information on how to use it, as well as for examples.
+Refer to this section for information on how to use it, as well as for examples.
+
+
+## Beyond the Docs
+
+While we try to keep this documentation up to date and as complete as possible, it may not always contain all of the latest information.
+
+Please also check the [Beyond the Docs](./Beyond-The-Docs.md) page for additional references.

docs/index.md

@@ -11,7 +11,13 @@ title: Home
 GregTech CEu Modern is a port of [GregTech Community Edition Unofficial](https://github.com/GregTechCEu/GregTech)
 to modern Minecraft versions.
 
+!!! danger "Work in Progress"
+    Please note that this documentation is currently heavily work-in-progress and therefore still missing a lot of content.
+
+    If you can't find what you're looking for, feel free to ask us on [our Discord](https://discord.gg/bWSWuYvURP).
 
-!!! question "Want to contribute to these docs?"
-    If you want to contribute to this documentation site, feel free to open a pull request at
-    [its GitHub repository](https://github.com/mikerooni/gtceu-modern-docs)
+
+## Want to Contribute?
+
+If you want to contribute to this documentation site, feel free to open a pull request on
+[its GitHub repository](https://github.com/mikerooni/gtceu-modern-docs).

docs/stylesheets/extra.css

@@ -10,4 +10,35 @@
 
 [data-md-color-scheme="slate"] .md-header, [data-md-color-scheme="slate"] .md-tabs {
     background-color: #007085;
+}
+
+
+/************************************************************/
+/******************   CUSTOM ADMONITIONS   ******************/
+/************************************************************/
+
+/* Link */
+
+:root {
+    /*
+     * Icon Name: material-link
+     * Source:    https://github.com/squidfunk/mkdocs-material/blob/master/material/templates/.icons/material/link.svg
+     * License:   Apache-2.0 (https://github.com/squidfunk/mkdocs-material/blob/master/material/templates/.icons/material/LICENSE)
+     */
+    --md-admonition-icon--link: url('data:image/svg+xml;charset=utf8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg>')
+}
+.md-typeset .admonition.link,
+.md-typeset details.link {
+    border-color: rgb(68, 138, 255);
+}
+.md-typeset .link > .admonition-title,
+.md-typeset .link > summary {
+    background-color: rgba(68, 138, 255, 0.1);
+}
+.md-typeset .link > .admonition-title::before,
+.md-typeset .link > summary::before {
+    background-color: rgb(68, 138, 255);
+
+    mask-image: var(--md-admonition-icon--link);
+    -webkit-mask-image: var(--md-admonition-icon--link);
 }