diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-02-20 19:15:42 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-20 19:15:42 +0100 |
| commit | 57622719edb912d7c3320f7e59cd6928e5c25e44 (patch) | |
| tree | e00db16dc54ce11b025cdb1bc8cf204bd6efebe3 /mkdocs/src/doc/docs/index.md | |
| parent | 1e10c6f47d605e1e730cb58aa44f3051ec5a493b (diff) | |
| download | dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.tar.gz dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.tar.bz2 dokka-57622719edb912d7c3320f7e59cd6928e5c25e44.zip | |
Exclude user guides from mkdocs documentation (#2868)
Diffstat (limited to 'mkdocs/src/doc/docs/index.md')
| -rw-r--r-- | mkdocs/src/doc/docs/index.md | 39 |
1 files changed, 5 insertions, 34 deletions
diff --git a/mkdocs/src/doc/docs/index.md b/mkdocs/src/doc/docs/index.md index 0f106c04..2cedfe35 100644 --- a/mkdocs/src/doc/docs/index.md +++ b/mkdocs/src/doc/docs/index.md @@ -1,38 +1,9 @@ # Dokka -`Dokka` is an API documentation engine for `Kotlin` that performs the same function as the `Javadoc` tool for `Java`, -but it's modern and highly pluggable. +Dokka is an API documentation engine for Kotlin. -Just like `Kotlin` itself, `Dokka` supports mixed-language projects (`Kotlin`/`Java`). It understands -[KDoc comments](https://kotlinlang.org/docs/reference/kotlin-doc.html) in `Kotlin` source files as well -as [Javadoc comments](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format) in `Java` -files, and can generate documentation in multiple formats including its own `HTML` format, Java's `Javadoc` lookalike -and `Markdown`. +If you want to learn how to use Dokka, see +[documentation on kotlinlang.org](https://kotlinlang.org/docs/dokka-introduction.html). -Some libraries that use `Dokka` for API reference docs: - -* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/) -* [kotlinx.serialization](https://kotlinlang.org/api/kotlinx.serialization/) -* [Ktor](https://api.ktor.io/) -* [Spring Framework](https://docs.spring.io/spring-framework/docs/current/kdoc-api/) - -___ - -`Dokka` provides support for the following build systems: - -* [Gradle](user_guide/applying/gradle.md) (preferred) -* [Maven](user_guide/applying/maven.md) -* [Command line](user_guide/applying/cli.md) - -___ - -`Dokka` is also very pluggable and comes with convenient plugin and extension point API. - -You can write a plugin to support [mermaid.js](community/plugins-list.md#mermaid) diagrams, -[mathjax](community/plugins-list.md#mathjax) formulas or even write custom processing of your own tags and annotations. - -For more info, see: - -* [Sample plugin tutorial](developer_guide/plugin-development/sample-plugin-tutorial.md) -* [Community plugins](community/plugins-list.md) -* [Developer guides](developer_guide/introduction.md) +If you want to learn more about Dokka's internals and/or how to write Dokka plugins, +see [Developer guides](developer_guide/introduction.md). |