Skip to content

Commit 151ae1a

Browse files
koshachykoshachy
authored
feat: add Kotlin API references overview (#4807)
* feat: add Kotlin API references overview * fix: fix the indentation
1 parent dbebf8f commit 151ae1a

File tree

4 files changed

+80
-1
lines changed

4 files changed

+80
-1
lines changed

‎docs/images/social/github.svg

Lines changed: 1 addition & 0 deletions
Loading

‎docs/kr.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@
283283
<toc-element toc-title="Ktor" href="https://ktor.io/"/>
284284
</toc-element>
285285
<toc-element toc-title="API reference">
286+
<toc-element toc-title="Overview" topic="api-references.topic"/>
286287
<toc-element toc-title="Standard library (stdlib)" href="https://kotlinlang.org/api/latest/jvm/stdlib/"/>
287288
<toc-element toc-title="Test library (kotlin.test)" href="https://kotlinlang.org/api/latest/kotlin.test/"/>
288289
<toc-element toc-title="Coroutines (kotlinx.coroutines)" href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/"/>

‎docs/topics/api-references.topic

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
3+
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
5+
id="api-references" title="API references">
6+
7+
<p>Welcome to the Kotlin API References page. Here you'll find links to the API documentation for the official Kotlin libraries and tools.</p>
8+
9+
<list columns="2">
10+
<li>
11+
<a href="https://kotlinlang.org/api/core/kotlin-stdlib/"><b>Standard library (stdlib)</b></a>
12+
<br/>
13+
<p>The Kotlin Standard library provides core functionality for Kotlin programming, including essential APIs such as collections, text and string processing, ranges, sequences, and more. It extends platform-specific APIs and provides a Kotlin-first API for working with them.</p>
14+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/JetBrains/kotlin">kotlin</a>
15+
<br/>
16+
</li>
17+
<li>
18+
<a href="https://kotlinlang.org/api/core/kotlin-test/"><b>Test library (kotlin.test)</b></a>
19+
<br/>
20+
<p>A multiplatform testing library that provides common testing annotations and utility functions. It supports integration with popular test frameworks on each platform and offers a unified testing experience across the Kotlin ecosystem.</p>
21+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/JetBrains/kotlin">kotlin</a>
22+
<br/>
23+
</li>
24+
<li>
25+
<a href="https://kotlinlang.org/api/kotlinx.coroutines/"><b>Coroutines (kotlinx.coroutines)</b></a>
26+
<br/>
27+
<p>A powerful library for asynchronous programming using Kotlin coroutines. It offers tools to support structured concurrency, asynchronous streams, synchronization primitives like mutexes and semaphores, testing, and more.</p>
28+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/Kotlin/kotlinx.coroutines">kotlinx.coroutines</a>
29+
<br/>
30+
</li>
31+
<li>
32+
<a href="https://kotlinlang.org/api/kotlinx.serialization/"><b>Serialization (kotlinx.serialization)</b></a>
33+
<br/>
34+
<p>A multiplatform serialization library. It provides a type-safe, compile-time mechanism for converting Kotlin objects to and from a variety of formats such as JSON, CBOR, and Protocol Buffers.</p>
35+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/Kotlin/kotlinx.serialization">kotlinx.serialization</a>
36+
<br/>
37+
</li>
38+
<li>
39+
<a href="https://kotlinlang.org/api/kotlinx-io/"><b>Kotlin I/O library (kotlinx-io)</b></a>
40+
<br/>
41+
<p>A multiplatform library for low-level I/O operations. It defines abstractions for reading from and writing to binary streams and buffers, designed to be efficient and portable across all Kotlin platforms.</p>
42+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/Kotlin/kotlinx-io">kotlinx-io</a>
43+
<br/>
44+
</li>
45+
<li>
46+
<a href="https://kotlinlang.org/api/kotlinx-datetime/"><b>Date and time (kotlinx-datetime)</b></a>
47+
<br/>
48+
<p>A multiplatform library for calendar-based computations. It provides representations of date values and supports timezone-specific operations.</p>
49+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/Kotlin/kotlinx-datetime">kotlinx-datetime</a>
50+
<br/>
51+
</li>
52+
<li>
53+
<a href="https://kotlinlang.org/api/kotlinx-metadata-jvm/"><b>JVM Metadata (kotlin-metadata-jvm)</b></a>
54+
<br/>
55+
<p>A library for reading and writing Kotlin metadata stored in JVM class files. It is primarily used by tools such as annotation processors, static analyzers, and compiler plugins.</p>
56+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/JetBrains/kotlin/tree/master/libraries/kotlinx-metadata">kotlinx-metadata</a>
57+
<br/>
58+
</li>
59+
<li>
60+
<a href="https://kotlinlang.org/api/kotlin-gradle-plugin/"><b>Kotlin Gradle plugins (kotlin-gradle-plugin)</b></a>
61+
<br/>
62+
<p>The Kotlin Gradle plugins for compiling, testing, and packaging Kotlin code. These plugins simplify JVM and multiplatform builds, manage dependencies, and integrate with IDEs and CI systems.</p>
63+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/JetBrains/kotlin/tree/master/libraries/tools/kotlin-gradle-plugin">kotlin-gradle-plugin</a>
64+
<br/>
65+
</li>
66+
<li>
67+
<a href="https://api.ktor.io/"><b>Ktor</b></a>
68+
<br/>
69+
<p>A framework for building asynchronous clients and servers in connected systems using Kotlin. Ktor is designed for scalability and flexibility and is deeply integrated with coroutines for non-blocking I/O and structured concurrency.</p>
70+
<img src="github.svg" width="18" alt="GitHub"/> <a href="https://github.com/ktorio/ktor">ktor</a>
71+
<br/>
72+
</li>
73+
</list>
74+
</topic>

‎redirects/site.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,7 @@
5858
to: https://kotlinfoundation.org/submitting-incompatible-changes/
5959

6060
- from: /docs/foundation-faq.html
61-
to: https://kotlinfoundation.org/faq/
61+
to: https://kotlinfoundation.org/faq/
62+
63+
- from: /docs/api
64+
to: /docs/api-references.html

0 commit comments

Comments
 (0)