Skip to content

Commit 88f5b9d

Browse files
committed
MPP: Include JS example bundle into documentation site
1 parent bdf23f2 commit 88f5b9d

File tree

5 files changed

+34
-16
lines changed

5 files changed

+34
-16
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This is a companion version for Kotlin 1.2.10 release.
1212
```kotlin
1313
launch {
1414
delay(1000)
15-
println("Hello from Kotlin Coroutine!")
15+
println("Hello from Kotlin Coroutines!")
1616
}
1717
```
1818

js/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,7 @@ Module name below corresponds to the artifact name in Maven/Gradle.
77

88
* [kotlinx-coroutines-core-js](kotlinx-coroutines-core-js/README.md) -- core coroutine builders and primitives.
99

10+
## Examples
11+
12+
* [example-frontend-js](example-frontend-js/README.md) -- frontend application written in Kotlin/JS
13+
that uses coroutines to implement animations in imperative style.

js/example-frontend-js/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Build application with
44

55
```
6-
gradlew :example-frontend-js:build
6+
gradlew :example-frontend-js:bundle
77
```
88

99
The resulting application can be found in `build/dist` subdirectory.

site/build.gradle

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,18 @@ task copyDocs(type: Copy, dependsOn: rootProject.getTasksByName("dokka", true))
77
into "$buildDir/gh-pages"
88
}
99

10-
task site(type: Exec, description: 'Generate github pages', dependsOn: copyDocs) {
10+
task copyExampleFrontendJs(type: Copy, dependsOn: ':example-frontend-js:bundle') {
11+
def srcBuildDir = project(':example-frontend-js').buildDir
12+
from "$srcBuildDir/dist"
13+
into "$buildDir/gh-pages/example-frontend-js"
14+
}
15+
16+
task site(type: Exec, description: 'Generate github pages', dependsOn: [copyDocs, copyExampleFrontendJs]) {
1117
workingDir "$buildDir/gh-pages"
1218
commandLine 'jekyll', 'build'
1319
}
1420

1521
task clean(type: Delete) {
1622
delete buildDir
1723
}
24+

site/docs/index.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,23 @@ Library support for Kotlin coroutines. This reference is a companion to
1010

1111
## Modules
1212

13-
[kotlinx-coroutines-core](kotlinx-coroutines-core) | Core primitives to work with coroutines
14-
[kotlinx-coroutines-io](kotlinx-coroutines-io) | Byte I/O channels (_unstable_, work in progress)
15-
[kotlinx-coroutines-reactive](kotlinx-coroutines-reactive) | Utilities for [Reactive Streams](http://www.reactive-streams.org)
16-
[kotlinx-coroutines-reactor](kotlinx-coroutines-reactor) | Utilities for [Reactor](https://projectreactor.io)
17-
[kotlinx-coroutines-rx1](kotlinx-coroutines-rx1) | Utilities for [RxJava 1.x](https://github.com/ReactiveX/RxJava/tree/1.x)
18-
[kotlinx-coroutines-rx2](kotlinx-coroutines-rx2) | Utilities for [RxJava 2.x](https://github.com/ReactiveX/RxJava)
19-
[kotlinx-coroutines-android](kotlinx-coroutines-android) | `UI` context for Android applications
20-
[kotlinx-coroutines-javafx](kotlinx-coroutines-javafx) | `JavaFx` context for JavaFX UI applications
21-
[kotlinx-coroutines-swing](kotlinx-coroutines-swing) | `Swing` context for Swing UI applications
22-
[kotlinx-coroutines-jdk8](kotlinx-coroutines-jdk8) | Integration with JDK8 `CompletableFuture` (Android API level 24)
23-
[kotlinx-coroutines-nio](kotlinx-coroutines-nio) | Integration with asynchronous IO on JDK7+ (Android O Preview)
24-
[kotlinx-coroutines-guava](kotlinx-coroutines-guava) | Integration with Guava [ListenableFuture](https://github.com/google/guava/wiki/ListenableFutureExplained)
25-
[kotlinx-coroutines-quasar](kotlinx-coroutines-quasar) | Integration with [Quasar](http://docs.paralleluniverse.co/quasar/)
13+
| Name | Description |
14+
| ---------------------------------------------------------- | ------------------------------------------------ |
15+
| [kotlinx-coroutines-core](kotlinx-coroutines-core) | Core primitives to work with coroutines |
16+
| [kotlinx-coroutines-io](kotlinx-coroutines-io) | Byte I/O channels (_unstable_, work in progress) |
17+
| [kotlinx-coroutines-reactive](kotlinx-coroutines-reactive) | Utilities for [Reactive Streams](http://www.reactive-streams.org) |
18+
| [kotlinx-coroutines-reactor](kotlinx-coroutines-reactor) | Utilities for [Reactor](https://projectreactor.io) |
19+
| [kotlinx-coroutines-rx1](kotlinx-coroutines-rx1) | Utilities for [RxJava 1.x](https://github.com/ReactiveX/RxJava/tree/1.x) |
20+
| [kotlinx-coroutines-rx2](kotlinx-coroutines-rx2) | Utilities for [RxJava 2.x](https://github.com/ReactiveX/RxJava) |
21+
| [kotlinx-coroutines-android](kotlinx-coroutines-android) | `UI` context for Android applications |
22+
| [kotlinx-coroutines-javafx](kotlinx-coroutines-javafx) | `JavaFx` context for JavaFX UI applications |
23+
| [kotlinx-coroutines-swing](kotlinx-coroutines-swing) | `Swing` context for Swing UI applications |
24+
| [kotlinx-coroutines-jdk8](kotlinx-coroutines-jdk8) | Integration with JDK8 `CompletableFuture` (Android API level 24) |
25+
| [kotlinx-coroutines-nio](kotlinx-coroutines-nio) | Integration with asynchronous IO on JDK7+ (Android O Preview) |
26+
| [kotlinx-coroutines-guava](kotlinx-coroutines-guava) | Integration with Guava [ListenableFuture](https://github.com/google/guava/wiki/ListenableFutureExplained) |
27+
| [kotlinx-coroutines-quasar](kotlinx-coroutines-quasar) | Integration with [Quasar](http://docs.paralleluniverse.co/quasar/) |
28+
29+
## Examples
30+
31+
* [example-frontend-js](example-frontend-js) -- frontend application written in Kotlin/JS
32+
that uses coroutines to implement animations in imperative style.

0 commit comments

Comments
 (0)