Update versions, add packages and artifacts information in some pages (…

…#2024)
korlibs · Nov 11, 2023 · 19d0f09 · 19d0f09
1 parent 6b13133
commit 19d0f09
Show file tree

Hide file tree

Showing 14 changed files with 54 additions and 23 deletions.
diff --git a/docs/_data/versions.yml b/docs/_data/versions.yml
@@ -1,5 +1,4 @@
-korge: 5.0.2
-korgeplugin: 5.0.2
+korge: 5.1.0
 gradle: 8.3
 coroutines: 1.7.3
-kotlin: 1.8.20-Beta
+kotlin: 1.9.20
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -130,7 +130,7 @@ <h5 class="offcanvas-title text-white" id="bdNavbarOffcanvasLabel">Bootstrap</h5
                             <li><h6 class="dropdown-header">v5 releases</h6></li>
                             <li>
                                 <a class="dropdown-item d-flex align-items-center justify-content-between active" aria-current="true" href="/">
-                                    Latest (5.0.x)
+                                    Latest (5.1.x)
                                     <i class="bi bis bi-check2 ms-auto"></i>
                                 </a>
                             </li>
@@ -250,6 +250,29 @@ <h1 class="bd-title mb-0" id="content">{{ page.title }}</h1>
                 if you find something invalid here.
                 {% endif %}
             </div>
+
+            {% if page.artifact or page.package or page.packages %}
+            <div style="margin-top:0.5em;">
+                {% if page.artifact %}
+                To access this functionality you can include the:
+                <code>{{ page.artifact }}:{{ site.data.versions.korge }}</code>
+                artifact from maven central.
+                {% endif %}
+                {% if page.package or page.packages %}
+                All the functionality yields in the
+                {% if page.packages %}
+                    {% for package in page.packages %}
+                    {% if forloop.index != 1 %}, {% endif %}
+                    <code>{{ package }}</code>
+                    {% endfor %}
+                    packages
+                {% else %}
+                <code>{{ page.package }}</code> package
+                {% endif %}
+                .
+                {% endif %}
+            </div>
+            {% endif %}
         </div>
 
 

diff --git a/docs/data-structures/index.md b/docs/data-structures/index.md
@@ -7,6 +7,8 @@ title_short: Introduction
 fa-icon: fa-tree
 children: /kds/
 priority: 0
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.datastructure
 ---
 
 <img src="/i/logos/kds.svg" width="196" height="196" style="float: left;margin: 0 16px 16px 0;" alt="KDS: Data Structures" />

diff --git a/docs/imaging/index.md b/docs/imaging/index.md
@@ -6,6 +6,8 @@ title: "Image"
 title_short: "Introduction"
 fa-icon: fa-image
 priority: 0
+artifact: 'com.soywiz.korge:korge-core'
+package: korlibs.image
 ---
 
 <img alt="KorIM" src="/i/logos/korim.svg" style="float:left;width:128px;height:128px;" />
@@ -16,8 +18,6 @@ This library is able to load PNG, JPEGs, BMPs, TGAs, PSDs and SVG vector images.
 Also allows rendering vectorial images using native rasterizers. 
 Also allows to use native image loaders for the fastest performance.
 
-[https://github.com/korlibs/korim](https://github.com/korlibs/korim)
-
 {% include stars.html project="korge" central="com.soywiz.korlibs.korim/korim" %}
 
 

diff --git a/docs/io/index.md b/docs/io/index.md
@@ -6,10 +6,10 @@ title: "I/O"
 title_short: Introduction
 fa-icon: fa-copy
 priority: 0
+artifact: 'com.soywiz.korge:korge-core'
+package: korlibs.io
 ---
 
 <img alt="KorIO" src="/i/logos/korio.svg" width="128" height="128" style="float: left;" />
 
 KorIO is a library for Charsets, Encodings, Checksums, Compression, I/O, Streams, Virtual File System, Networking, Http, WebSockets, Serialization...
-
-[https://github.com/korlibs/korio](https://github.com/korlibs/korio)
diff --git a/docs/io/serialization.md b/docs/io/serialization.md
@@ -7,6 +7,8 @@ title_prefix: KorIO
 description: "JSON, TOML, YAML, XML and Properties serialization"
 fa-icon: fa-code
 priority: 9
+artifact: 'com.soywiz.korge:korge-core'
+package: korlibs.serialization
 ---
 
 KorIO has utilities for serializing and deserializing typical formats.

diff --git a/docs/math/index.md b/docs/math/index.md
@@ -6,10 +6,12 @@ title: "Maths"
 title_short: Introduction
 fa-icon: fa-calculator
 priority: 0
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.math
 ---
 
 <img src="/i/logos/korma.svg" width="128" height="128" alt="KorMA" style="float:left; margin: 0 16px 16px 0;" />
 
-Korma is a mathematic library for multiplatform Kotlin 1.3 mostly focused on geometry.
+Korma is a mathematic library for multiplatform Kotlin mostly focused on geometry.
 
 [https://github.com/korlibs/korma](https://github.com/korlibs/korma)
diff --git a/docs/reference/audio.md b/docs/reference/audio.md
@@ -5,11 +5,13 @@ layout: default
 title: "Audio"
 fa-icon: fa-headphones
 priority: 70
+artifact: 'com.soywiz.korge:korge-core'
+package: korlibs.audio
 ---
 
 <img alt="KorAU" src="/i/logos/korau.svg" width="128" height="128" style="float: left;margin-right:1em;" />
 
-[KorAU](https://github.com/korlibs/korge/tree/main/korau), Kotlin cORoutines AUdio - Audio playing, and sound file decoding
+KorAU, Kotlin cORoutines AUdio - Audio playing, and sound file decoding
 
 It supports playing sounds, creating dynamic audio streams and decoding audio file formats: wav, mp3 and ogg.
 

diff --git a/docs/reference/crypto.md b/docs/reference/crypto.md
@@ -7,7 +7,7 @@ fa-icon: fa-lock
 priority: 950
 ---
 
-Krypto is a cryptography library for Multiplatform Kotlin 1.3.
+Krypto is a cryptography library for Multiplatform Kotlin.
 
 
 ## SecureRandom

diff --git a/docs/reference/injector.md b/docs/reference/injector.md
@@ -5,12 +5,11 @@ layout: default
 title: "Injector"
 fa-icon: fa-puzzle-piece
 priority: 970
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.inject
 ---
 
 Portable Kotlin Common package to do dependency injection.
-Part of `korge-foundation` (previously korinject)
-
-
 
 ## Creating a new injector
 

diff --git a/docs/reference/logger.md b/docs/reference/logger.md
@@ -5,10 +5,10 @@ layout: default
 title: "Logger"
 fa-icon: fa-bell
 priority: 60
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.logger
 ---
 
-Klogger is a logger library for multiplatform Kotlin.
-
 This module provides a simple interface to do logging into suitable outputs like javascript's console or stdout/stderr.
 
 ## Console

diff --git a/docs/reference/memory.md b/docs/reference/memory.md
@@ -5,13 +5,13 @@ layout: default
 title: Memory
 fa-icon: fa-microchip
 priority: 59
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.memory
 ---
 
 <img src="/i/logos/kmem.svg" width="196" height="196" style="float: left;margin: 0 16px 16px 0;" alt="KMEM: Memory Utilities" />
 
-Kmem is bit, array and fast memory utilities library for multiplatform Kotlin 1.3
-
-[https://github.com/korlibs/kmem](https://github.com/korlibs/kmem)
+Kmem is bit, array and fast memory utilities library for multiplatform Kotlin
 
 ## arraycopy and arrayfill
 

diff --git a/docs/templates/index.md b/docs/templates/index.md
@@ -6,11 +6,13 @@ title: "Templates"
 title_short: Introduction
 fa-icon: far fa-file-code
 priority: 0
+artifact: 'com.soywiz.korge:korge-core'
+package: korlibs.template
 ---
 
 <img alt="KorTE" src="/i/logos/korte.svg" width="128" height="128" style="float: left;" />
 
-KorTE is a asynchronous template engine for Multiplatform Kotlin 1.3.
+KorTE is a asynchronous template engine for Multiplatform Kotlin.
 
 It is a non-strict super set of [twig](https://twig.symfony.com/) / [django](https://docs.djangoproject.com/en/2.1/topics/templates/) / [atpl.js](https://github.com/soywiz/atpl.js) / [jinjava](https://github.com/HubSpot/jinjava) template engines and can support [liquid template engine](https://shopify.github.io/liquid/) too with frontmatter.
 
@@ -21,8 +23,6 @@ But can also work on Native when using untyped model data or making models to im
 
 It allows to call suspend methods from within templates.
 
-<https://github.com/korlibs/korte>
-
 Live demo (editable) [[source code]](https://github.com/korlibs/korte-samples/blob/master/korte-sample-browser/src/main/kotlin/main.kt){:target="_blank",:rel="noopener"}:
 
 <embed src="https://korlibs.github.io/korte-samples/korte-sample-browser/web/" style="width: 100%;height:50vh;" />

diff --git a/docs/time/index.md b/docs/time/index.md
@@ -6,9 +6,11 @@ title_short: Introduction
 group: time
 fa-icon: fa-clock
 priority: 0
+artifact: 'com.soywiz.korge:korge-foundation'
+package: korlibs.time
 ---
 
-Klock is a Date & Time library for Multiplatform Kotlin 1.3.
+Klock is a Date & Time library for Multiplatform Kotlin.
 
 It is designed to be as allocation-free as possible using Kotlin inline classes,
 to be consistent and portable across targets since all the code is written in Common Kotlin,