Documentation

.gitignore

@@ -0,0 +1,12 @@
+/.idea
+/.vscode
+/_site
+/.sass-cache
+/.jekyll-metadata
+/.jekyll-cache
+/.gradle
+/.idea
+*.iws
+*.iml
+*.ipr
+.DS_Store

.obsidian/app.json

@@ -0,0 +1 @@
+{}

.obsidian/appearance.json

@@ -0,0 +1,3 @@
+{
+  "accentColor": ""
+}

.obsidian/core-plugins-migration.json

@@ -0,0 +1,30 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "properties": false,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": false,
+  "sync": false
+}

.obsidian/core-plugins.json

@@ -0,0 +1,20 @@
+[
+  "file-explorer",
+  "global-search",
+  "switcher",
+  "graph",
+  "backlink",
+  "canvas",
+  "outgoing-link",
+  "tag-pane",
+  "page-preview",
+  "daily-notes",
+  "templates",
+  "note-composer",
+  "command-palette",
+  "editor-status",
+  "bookmarks",
+  "outline",
+  "word-count",
+  "file-recovery"
+]

.obsidian/graph.json

@@ -0,0 +1,22 @@
+{
+  "collapse-filter": true,
+  "search": "",
+  "showTags": false,
+  "showAttachments": false,
+  "hideUnresolved": false,
+  "showOrphans": true,
+  "collapse-color-groups": true,
+  "colorGroups": [],
+  "collapse-display": true,
+  "showArrow": false,
+  "textFadeMultiplier": 0,
+  "nodeSizeMultiplier": 1,
+  "lineSizeMultiplier": 1,
+  "collapse-forces": true,
+  "centerStrength": 0.518713248970312,
+  "repelStrength": 10,
+  "linkStrength": 1,
+  "linkDistance": 250,
+  "scale": 1,
+  "close": false
+}

.obsidian/hotkeys.json

@@ -0,0 +1 @@
+{}

.obsidian/workspace.json

@@ -0,0 +1,146 @@
+{
+  "main": {
+    "id": "4989eb71611d7733",
+    "type": "split",
+    "children": [
+      {
+        "id": "f2290b03438d05f9",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "6d4dcb688f3de535",
+            "type": "leaf",
+            "state": {
+              "type": "empty",
+              "state": {}
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "vertical"
+  },
+  "left": {
+    "id": "534c5ad7cc8d3559",
+    "type": "split",
+    "children": [
+      {
+        "id": "c23e38995c19fe59",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "f316c1920829492d",
+            "type": "leaf",
+            "state": {
+              "type": "file-explorer",
+              "state": {
+                "sortOrder": "alphabetical"
+              }
+            }
+          },
+          {
+            "id": "37870c0aad7643e4",
+            "type": "leaf",
+            "state": {
+              "type": "search",
+              "state": {
+                "query": "",
+                "matchingCase": false,
+                "explainSearch": false,
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical"
+              }
+            }
+          },
+          {
+            "id": "f68bcd260ff30c7e",
+            "type": "leaf",
+            "state": {
+              "type": "bookmarks",
+              "state": {}
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300
+  },
+  "right": {
+    "id": "59bc338dc566784c",
+    "type": "split",
+    "children": [
+      {
+        "id": "8804f2ed8a4a44a6",
+        "type": "tabs",
+        "children": [
+          {
+            "id": "704f2be54bfa80bd",
+            "type": "leaf",
+            "state": {
+              "type": "backlink",
+              "state": {
+                "collapseAll": false,
+                "extraContext": false,
+                "sortOrder": "alphabetical",
+                "showSearch": false,
+                "searchQuery": "",
+                "backlinkCollapsed": false,
+                "unlinkedCollapsed": true
+              }
+            }
+          },
+          {
+            "id": "c7ecd6a8dc0614b5",
+            "type": "leaf",
+            "state": {
+              "type": "outgoing-link",
+              "state": {
+                "linksCollapsed": false,
+                "unlinkedCollapsed": true
+              }
+            }
+          },
+          {
+            "id": "197316994978a069",
+            "type": "leaf",
+            "state": {
+              "type": "tag",
+              "state": {
+                "sortOrder": "frequency",
+                "useHierarchy": true
+              }
+            }
+          },
+          {
+            "id": "c46bb172cdae62ea",
+            "type": "leaf",
+            "state": {
+              "type": "outline",
+              "state": {}
+            }
+          }
+        ]
+      }
+    ],
+    "direction": "horizontal",
+    "width": 300
+  },
+  "left-ribbon": {
+    "hiddenItems": {
+      "switcher:Open quick switcher": false,
+      "graph:Open graph view": false,
+      "canvas:Create new canvas": false,
+      "daily-notes:Open today's daily note": false,
+      "templates:Insert template": false,
+      "command-palette:Open command palette": false
+    }
+  },
+  "active": "6d4dcb688f3de535",
+  "lastOpenFiles": [
+    "io/index.md",
+    "2023-12-01.md",
+    "io/astreams.md"
+  ]
+}

404.html

@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

CNAME

@@ -0,0 +1 @@
+docs.korge.org

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Carlos Ballesteros Velasco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,24 @@
-# docs.korge.org
+# docs.korge.org
+This is the offical documentation of the framework Korlibs.
+Contributions in every way are welcome.
+
+To launch the documentation locally on your PC there are 2 options:
+
+
+## Option 1: [Install jekyll](https://jekyllrb.com/docs/installation/)
+
+Then execute `jekyll s`
+
+## Option 2: [install docker](https://docs.docker.com/get-docker/)
+
+Then execute `./jekyll.sh` on linux or `jekyll2.bat` on Windows
+
+## Advices
+
+To simplify image illustration and editing. I recommend:
+
+* Snagit - Configured with `cmd+shift+2` on MacOS
+  * After creating and editing, you can press `cmd+c` to copy and use the Paste Images into Markdown plugin to create an image
+* Webstorm
+  * [Paste Images into Markdown Webstorm plugin](https://github.com/holgerbrandl/pasteimages)
+

_config.yml

@@ -0,0 +1,29 @@
+title: KorGE
+email: [email protected]
+description: Modern Kotlin Common Libraries for Full Stack development
+authors: soywiz and KorGE authors
+analytics_id: G-KV32JER3MJ
+exclude:
+  - ".gradle"
+  - ".idea"
+  - ".sass-cache"
+  - ".vscode"
+  - "@old"
+baseurl: ""
+url: "https://korlibs.soywiz.com"
+edit_root_url: https://github.com/korlibs/korge/blob/main/docs/
+blog_url: ""
+project_url: https://github.com/korlibs
+google_search_id: 001447907640164080602:ej0h0w0ufr0
+github_username:  korlibs
+# DISQUS is super intrusive lately
+#disqus_id: "korlibs-documentation"
+markdown: kramdown
+kramdown:
+  syntax_highlighter_opts:
+    disable : true
+sass:
+  sass_dir: css
+#plugins:
+  #- jekyll-redirect-from
+  #- hook-add-last-modified-date

_data/footer_sections.yml

@@ -0,0 +1,24 @@
+- name: Links
+  links:
+    - { name: "Documentation", url: "/" }
+    - { name: "Blog", url: "https://blog.korge.org/" }
+    - { name: "Dokka", url: "https://dokka.korge.org/" }
+- name: Guides
+  links:
+    - { name: "Views", url: "/views/" }
+    - { name: "Scenes", url: "/scenes/" }
+    - { name: "Math", url: "/math/" }
+    - { name: "I/O", url: "/io/" }
+    - { name: "Data Structures", url: "/data-structures/" }
+- name: Community
+  links:
+    - { name: "Discord", url: "https://discord.korge.org/" }
+    - { name: "Github Discussions", url: "https://forum.korge.org/" }
+    - { name: "Twitter", url: "https://twitter.korge.org/" }
+    - { name: "Youtube", url: "https://youtube.korge.org/" }
+- name: Tutorials
+  links:
+    - { name: "2048", url: "/tutorials/2048/" }
+    - { name: "Chess", url: "/tutorials/chess/" }
+    - { name: "Connect-4", url: "/tutorials/connect-4/" }
+    - { name: "Dungeon Explorer", url: "/tutorials/dungeon/" }

_data/header_sections.yml

@@ -0,0 +1,11 @@
+left:
+  - { title: "Docs", url: "/" }
+  - { title: "KorGE", url: "https://korge.org/" }
+  - { title: "Blog", url: "https://blog.korge.org/" }
+  - { title: "Dokka", url: "https://dokka.korge.org/" }
+  - { title: "Discussions", url: "https://forum.korge.org/", icon: "bi bi-chat-quote" }
+right:
+  - { title: "GitHub", url: "https://github.com/korlibs/korge", icon: "bi bi-github" }
+  - { title: "Twitter", url: "https://twitter.korge.org/", icon: "bi bi-twitter" }
+  - { title: "Discord", url: "https://discord.korge.org/", icon: "bi bi-discord" }
+  - { title: "Youtube", url: "https://youtube.korge.org/", icon: "bi bi-youtube" }