-
Notifications
You must be signed in to change notification settings - Fork 405
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Sarah Haggarty <sarahhaggarty@users.noreply.github.com>
- Loading branch information
1 parent
2161c39
commit 7544a21
Showing
78 changed files
with
5,734 additions
and
626 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Dokka documentation | ||
|
||
This folder contains the Dokka documentation that is available on [kotlinlang.org](https://kotlinlang.org/). | ||
|
||
Our documentation is written in Markdown format with some domain specific language (DSL) constructs that are used at | ||
JetBrains. | ||
|
||
If you wish to contribute to the documentation, please read through | ||
[Kotlin documentation guidelines](https://docs.google.com/document/d/1mUuxK4xwzs3jtDGoJ5_zwYLaSEl13g_SuhODdFuh2Dc/edit). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
|
||
<buildprofiles> | ||
<variables> | ||
<enable-browser-edits>true</enable-browser-edits> | ||
<browser-edits-url>https://github.com/Kotlin/dokka/edit/master/docs/</browser-edits-url> | ||
<allow-indexable-eaps>true</allow-indexable-eaps> | ||
</variables> | ||
<build-profile product="kl"/> | ||
</buildprofiles> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE product-profile | ||
SYSTEM "https://resources.jetbrains.com/stardust/product-profile.dtd"> | ||
|
||
<product-profile id="kl" | ||
name="dokka" | ||
start-page="dokka-introduction.md"> | ||
|
||
<chunk include-id="dokka"> | ||
<toc-element id="dokka-introduction.md"/> | ||
<toc-element id="dokka-get-started.md"/> | ||
<toc-element toc-title="Run Dokka"> | ||
<toc-element id="dokka-gradle.md"/> | ||
<toc-element id="dokka-maven.md"/> | ||
<toc-element id="dokka-cli.md"/> | ||
</toc-element> | ||
<toc-element toc-title="Output formats"> | ||
<toc-element id="dokka-html.md"/> | ||
<toc-element id="dokka-markdown.md"/> | ||
<toc-element id="dokka-javadoc.md"/> | ||
</toc-element> | ||
<toc-element id="dokka-plugins.md"/> | ||
</chunk> | ||
</product-profile> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/stardust/ihp.dtd"> | ||
|
||
<ihp version="2.0"> | ||
<!-- <categories src="categories.list"/>--> | ||
<module name="dokka"/> | ||
<topics dir="topics"/> | ||
<images dir="images"/> | ||
<vars src="vars.list"/> | ||
<product src="dokka.tree" version="%dokkaVersion%" /> | ||
<settings> | ||
<default-property element-name="toc-element" property-name="show-structure-depth" value="2"/> | ||
</settings> | ||
</ihp> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
[//]: # (title: Get started) | ||
|
||
Below you can find simple instructions to help you get started with Dokka. | ||
|
||
<tabs group="build-script"> | ||
<tab title="Gradle Kotlin DSL" group-key="kotlin"> | ||
|
||
Apply the Gradle plugin for Dokka in the root build script of your project: | ||
|
||
```kotlin | ||
plugins { | ||
id("org.jetbrains.dokka") version "%dokkaVersion%" | ||
} | ||
``` | ||
|
||
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need | ||
to apply the Gradle plugin within subprojects as well: | ||
|
||
```kotlin | ||
subprojects { | ||
apply(plugin = "org.jetbrains.dokka") | ||
} | ||
``` | ||
|
||
To generate documentation, run the following Gradle tasks: | ||
|
||
* `dokkaHtml` for single-project builds | ||
* `dokkaHtmlMultiModule` for multi-project builds | ||
|
||
By default, the output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule`. | ||
|
||
To learn more about using Dokka with Gradle, see [Gradle](dokka-gradle.md). | ||
|
||
</tab> | ||
<tab title="Gradle Groovy DSL" group-key="groovy"> | ||
|
||
Apply the Gradle plugin for Dokka in the root build script of your project: | ||
|
||
```groovy | ||
plugins { | ||
id 'org.jetbrains.dokka' version '%dokkaVersion%' | ||
} | ||
``` | ||
|
||
When documenting [multi-project](https://docs.gradle.org/current/userguide/multi_project_builds.html) builds, you need | ||
to apply the Gradle plugin within subprojects as well: | ||
|
||
```groovy | ||
subprojects { | ||
apply plugin: 'org.jetbrains.dokka' | ||
} | ||
``` | ||
|
||
To generate documentation, run the following Gradle tasks: | ||
|
||
* `dokkaHtml` for single-project builds | ||
* `dokkaHtmlMultiModule` for multi-project builds | ||
|
||
By default, the output directory is set to `/build/dokka/html` and `/build/dokka/htmlMultiModule`. | ||
|
||
To learn more about using Dokka with Gradle, see [Gradle](dokka-gradle.md). | ||
|
||
</tab> | ||
<tab title="Maven" group-key="mvn"> | ||
|
||
Add the Maven plugin for Dokka to the `plugins` section of your POM file: | ||
|
||
```xml | ||
<build> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.jetbrains.dokka</groupId> | ||
<artifactId>dokka-maven-plugin</artifactId> | ||
<version>%dokkaVersion%</version> | ||
<executions> | ||
<execution> | ||
<phase>pre-site</phase> | ||
<goals> | ||
<goal>dokka</goal> | ||
</goals> | ||
</execution> | ||
</executions> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
``` | ||
|
||
To generate documentation, run the `dokka:dokka` goal. | ||
|
||
By default, the output directory is set to `target/dokka`. | ||
|
||
To learn more about using Dokka with Maven, see [Maven](dokka-maven.md). | ||
|
||
</tab> | ||
</tabs> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
[//]: # (title: Introduction) | ||
|
||
Dokka is an API documentation engine for Kotlin. | ||
|
||
Just like Kotlin itself, Dokka supports mixed-language projects. It understands Kotlin's | ||
[KDoc comments](https://kotlinlang.org/docs/kotlin-doc.html#kdoc-syntax) and Java's | ||
[Javadoc comments](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html). | ||
|
||
Dokka can generate documentation in multiple formats, including its own modern [HTML format](dokka-html.md), | ||
multiple flavors of [Markdown](dokka-markdown.md), and Java's [Javadoc HTML](dokka-javadoc.md). | ||
|
||
Here are some libraries that use Dokka for their API reference documentation: | ||
|
||
* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/) | ||
* [Bitmovin](https://cdn.bitmovin.com/player/android/3/docs/index.html) | ||
* [Hexagon](https://hexagonkt.com/api/index.html) | ||
* [Ktor](https://api.ktor.io/) | ||
* [OkHttp](https://square.github.io/okhttp/4.x/okhttp/okhttp3/) (Markdown) | ||
|
||
You can run Dokka using [Gradle](dokka-gradle.md), [Maven](dokka-maven.md) or from the [command line](dokka-cli.md). It is also | ||
[highly pluggable](dokka-plugins.md). | ||
|
||
See [Get started](dokka-get-started.md) to take your first steps in using Dokka. | ||
|
||
## Community | ||
|
||
Dokka has a dedicated `#dokka` channel in [Kotlin Community Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up) | ||
where you can chat about Dokka, its plugins and how to develop them, as well as get in touch with maintainers. |
Oops, something went wrong.