aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 353a5928..b662a556 100644
--- a/README.md
+++ b/README.md
@@ -183,13 +183,13 @@ dokka {
#### Multiplatform
Since version 0.9.19 dokka supports multiplatform projects. For a general understanding how a multiplatform documentation is generated, please consult the [FAQ](https://github.com/Kotlin/dokka/wiki/faq).
-In the multiplatform mode, the `configuration` block is replaced by a `multiplatform` block which has inner blocks for each platform. The inner blocks can be named arbitrary, however if you want to use source roots and classpath provided by Kotlin Multiplatform plugin, they must have the same names. See the example blow:
+In the multiplatform mode, the `configuration` block is replaced by a `multiplatform` block which has inner blocks for each platform. The inner blocks can be named arbitrarly, however if you want to use source roots and classpath provided by Kotlin Multiplatform plugin, they must have the same names. See an example below:
Groovy
```groovy
kotlin { // Kotlin Multiplatform plugin configuration
jvm()
- js("customName")
+ js("customName") // Define a js platform named "customName" If you want to generate docs for it, you need to have this name in dokka configuration below
}
dokka {