diff options
| author | IgnatBeresnev <ignat.beresnev@jetbrains.com> | 2023-03-30 13:14:29 +0200 |
|---|---|---|
| committer | IgnatBeresnev <ignat.beresnev@jetbrains.com> | 2023-03-30 13:14:29 +0200 |
| commit | 26dae2f43dd4daa841cb013fdc108ecfada56021 (patch) | |
| tree | 8d89829132c86a968801bfeece3f5c1524163e2d /docs/topics/formats/dokka-html.md | |
| parent | 2b73ddd36d226e5547398daaf0e4370e48f4bb46 (diff) | |
| download | dokka-26dae2f43dd4daa841cb013fdc108ecfada56021.tar.gz dokka-26dae2f43dd4daa841cb013fdc108ecfada56021.tar.bz2 dokka-26dae2f43dd4daa841cb013fdc108ecfada56021.zip | |
Correct the template file format in user documentation
Diffstat (limited to 'docs/topics/formats/dokka-html.md')
| -rw-r--r-- | docs/topics/formats/dokka-html.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/topics/formats/dokka-html.md b/docs/topics/formats/dokka-html.md index b2c556e4..1b2d916d 100644 --- a/docs/topics/formats/dokka-html.md +++ b/docs/topics/formats/dokka-html.md @@ -236,13 +236,13 @@ You can change the header completely, add your own banners/menus/search, load an Dokka uses the following templates: -| **Template** | **Description** | -|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------| -| `base.ftl` | Defines the general design of all pages to be rendered. | -| `includes/header.ft` | The page header that by default contains the logo, version, source set selector, light/dark theme switch, and search. | -| `includes/footer.ft` | The page footer that contains the `footerMessage` [configuration option](#configuration) and copyright. | -| `includes/page_metadata.ft` | Metadata used within `<head>` container. | -| `includes/source_set_selector.ft` | [The source set](https://kotlinlang.org/docs/multiplatform-discover-project.html#source-sets) selector in the header. | +| **Template** | **Description** | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| `base.ftl` | Defines the general design of all pages to be rendered. | +| `includes/header.ftl` | The page header that by default contains the logo, version, source set selector, light/dark theme switch, and search. | +| `includes/footer.ftl` | The page footer that contains the `footerMessage` [configuration option](#configuration) and copyright. | +| `includes/page_metadata.ftl` | Metadata used within `<head>` container. | +| `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). |