Skip to content

Commit

Permalink
Correct the template file format in user documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnatBeresnev committed Mar 30, 2023
1 parent 2b73ddd commit 26dae2f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/topics/formats/dokka-html.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 26dae2f

Please sign in to comment.