Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update versions, add packages and artifacts information in some pages #2024

Merged
merged 1 commit into from
Nov 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/_data/versions.yml
Original file line number Diff line number Diff line change
@@ -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
25 changes: 24 additions & 1 deletion docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>


Expand Down
2 changes: 2 additions & 0 deletions docs/data-structures/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down
4 changes: 2 additions & 2 deletions docs/imaging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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;" />
Expand All @@ -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" %}


Expand Down
4 changes: 2 additions & 2 deletions docs/io/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 2 additions & 0 deletions docs/io/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 3 additions & 1 deletion docs/math/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 3 additions & 1 deletion docs/reference/audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/injector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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;" />
Expand Down
4 changes: 3 additions & 1 deletion docs/time/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading