Skip to content

Commit

Permalink
Fix problems encountered while proofreading
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnatBeresnev committed Jan 3, 2023
1 parent a806517 commit 14901a2
Showing 1 changed file with 7 additions and 14 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,6 @@ subprojects {
}
```

To generate documentation run the following Gradle tasks:

* `dokkaHtml` for single-project builds.
* `dokkaHtmlMultiModule` for multi-module builds.

By default, output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule` respectively.

</details>

<details>
Expand All @@ -74,14 +67,14 @@ subprojects {
}
```

</details>

To generate documentation run the following Gradle tasks:

* `dokkaHtml` for single-project builds.
* `dokkaHtmlMultiModule` for multi-module builds.

By default, output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule`.

</details>
By default, output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule` respectively.

Learn more about Gradle configuration in a separate [topic dedicated to Gradle](TODO).

Expand Down Expand Up @@ -116,15 +109,15 @@ Learn more about Maven configuration in a separate [topic dedicated to Maven](TO
### CLI

It is possible to run Dokka from command line without having to use any of the build tools, but it's more
difficult to set up and for that reason is not covered by this Quickstart guide.
difficult to set up and for that reason it is not covered by this Quickstart guide.

Please consult [documentation for command line runner](https://kotlin.github.io/dokka/1.7.20/user_guide/applying/cli/)
to learn how to use it.

### Android

In addition to applying and configuring Dokka, you can apply Dokka's
[Android documentation plugin](plugins/android-documentation) which aims to improve documentation experience on the
[Android documentation plugin](plugins/android-documentation), which aims to improve documentation experience on the
Android platform:

<details open>
Expand Down Expand Up @@ -175,13 +168,13 @@ dependencies {

### HTML

HTML is Dokka's default, stable and recommended format. You can see it in action by browsing documentation for
HTML is Dokka's default, stable and recommended output format. You can see it in action by browsing documentation for
[kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/).

HTML format is configurable and, among other things, allows you to modify stylesheets, add custom image assets, change
footer message and revamp the structure of generated HTML pages through templates.

For more details and examples see [HTML format](TODO) topic.
For more details and examples, see [HTML format](TODO) topic.

### Markdown

Expand Down

0 comments on commit 14901a2

Please sign in to comment.