Skip to content

Commit

Permalink
Update kotlinlang docs version to 1.9.20 (#3512)
Browse files Browse the repository at this point in the history
  • Loading branch information
@IgnatBeresnev
IgnatBeresnev committed Mar 5, 2024
1 parent 7ccc48e commit 471b7c0
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
16 changes: 8 additions & 8 deletions docs/topics/dokka-plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ From there, the plugin extends Dokka by itself - no further action is needed.
>
{type="note"}

Let's have a look at how you can apply the [mathjax plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/mathjax)
Let's have a look at how you can apply the [mathjax plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-mathjax)
to your project:

<tabs group="build-script">
Expand Down Expand Up @@ -266,13 +266,13 @@ If you are using [JSON configuration](dokka-cli.md#run-with-json-configuration),

Here are some notable Dokka plugins that you might find useful:

| **Name** | **Description** |
|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| [Android documentation plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/android-documentation) | Improves the documentation experience on Android |
| [Versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/versioning) | Adds version selector and helps to organize documentation for different versions of your application/library |
| [MermaidJS HTML plugin](https://github.com/glureau/dokka-mermaid) | Renders [MermaidJS](https://mermaid-js.github.io/mermaid/#/) diagrams and visualizations found in KDocs |
| [Mathjax HTML plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/mathjax) | Pretty prints mathematics found in KDocs |
| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |
| **Name** | **Description** |
|------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
| [Android documentation plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-android-documentation) | Improves the documentation experience on Android |
| [Versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-versioning) | Adds version selector and helps to organize documentation for different versions of your application/library |
| [MermaidJS HTML plugin](https://github.com/glureau/dokka-mermaid) | Renders [MermaidJS](https://mermaid-js.github.io/mermaid/#/) diagrams and visualizations found in KDocs |
| [Mathjax HTML plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-mathjax) | Pretty prints mathematics found in KDocs |
| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugins-kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |

If you are a Dokka plugin author and would like to add your plugin to this list, get in touch with maintainers
via [Slack](dokka-introduction.md#community) or [GitHub](https://github.com/Kotlin/dokka/).
16 changes: 8 additions & 8 deletions docs/topics/formats/dokka-html.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ It's also possible to override Dokka's default stylesheets by providing files wi
| `prism.css` | Styles for [PrismJS](https://prismjs.com/) syntax highlighter |

The source code for all of Dokka's stylesheets is
[available on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/styles).
[available on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/styles).

### Customize assets

Expand All @@ -210,7 +210,7 @@ It's possible to override Dokka's images and icons by providing files with the s
useful and relevant one being `logo-icon.svg`, which is the image that's used in the header. The rest is mostly icons.

You can find all images used by Dokka on
[GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/images).
[GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/images).

### Change the logo

Expand Down Expand Up @@ -244,7 +244,7 @@ Dokka uses the following templates:
| `includes/source_set_selector.ftl` | [The source set](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets) selector in the header. |

The base template is `base.ftl` and it includes all of the remaining listed templates. You can find the source code for all of Dokka's templates
[on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/base/src/main/resources/dokka/templates).
[on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-base/src/main/resources/dokka/templates).

You can override any template by using the `templatesDir` [configuration option](#configuration). Dokka searches
for the exact template names within the given directory. If it fails to find user-defined templates, it uses the
Expand Down Expand Up @@ -275,8 +275,8 @@ context and thus they need to be resolved at later stages by the [MultiModule](d

You can also use the following Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html):

| **Variable** | **Description** |
|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<@content/>` | The main page content. |
| `<@resources/>` | Resources such as scripts and stylesheets. |
| `<@version/>` | The module version taken from configuration. If the [versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/versioning) is applied, it is replaced with a version navigator. |
| **Variable** | **Description** |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<@content/>` | The main page content. |
| `<@resources/>` | Resources such as scripts and stylesheets. |
| `<@version/>` | The module version taken from configuration. If the [versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-versioning) is applied, it is replaced with a version navigator. |
4 changes: 2 additions & 2 deletions docs/topics/formats/dokka-javadoc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ or an exact copy.
![Screenshot of javadoc output format](javadoc-format-example.png){width=706}

All Kotlin code and signatures are rendered as seen from Java's perspective. This is achieved with our
[Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/kotlin-as-java), which comes bundled and
[Kotlin as Java Dokka plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-kotlin-as-java), which comes bundled and
applied by default for this format.

The Javadoc output format is implemented as a [Dokka plugin](dokka-plugins.md), and it is maintained by the Dokka team.
It is open source and you can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/javadoc).
It is open source and you can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-javadoc).

## Generate Javadoc documentation

Expand Down
4 changes: 2 additions & 2 deletions docs/topics/formats/dokka-markdown.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For more information, see the CLI runner's documentation for [Other output forma
</tab>
</tabs>

You can find the source code [on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/gfm).
You can find the source code [on GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-gfm).

## Jekyll

Expand Down Expand Up @@ -170,4 +170,4 @@ For more information, see the CLI runner's documentation for [Other output forma
</tab>
</tabs>

You can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/plugins/jekyll).
You can find the source code on [GitHub](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-jekyll).
4 changes: 2 additions & 2 deletions docs/v.list
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

<vars>
<var name="dokkaVersion"
value="1.9.10"
value="1.9.20"
type="string"/>
<var name="kotlinVersion"
value="1.9.10"
value="1.9.22"
type="string"/>
</vars>

0 comments on commit 471b7c0

Please sign in to comment.