1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
# Configuration specific to HTML format
## Prerequisites
Dokka's HTML format requires a web server to view documentation correctly.
This can be achieved by using the one that is build in IntelliJ or providing your own.
If this requisite is not fulfilled Dokka with fail to load navigation pane and search bars.
!!! important
Concepts specified below apply only to configuration of the Base Plugin (that contains HTML format)
and needs to be applied via pluginsConfiguration and not on the root one.
## Modifying assets
It is possible to change static assets that are used to generate dokka's HTML.
Currently, user can modify:
* customAssets
* customStyleSheets
Every file provided in those values will be applied to **every** page.
Dokka uses 4 stylesheets:
* `style.css` - main css file responsible for styling the page
* `jetbrains-mono.css` - fonts used across dokka
* `logo-styles.css` - logo styling
* [`prism.css`](https://github.com/Kotlin/dokka/blob/master/plugins/base/src/main/resources/dokka/styles/prism.css) - code highlighting
Also, it uses js scripts. The actual ones are [here](https://github.com/Kotlin/dokka/tree/master/plugins/base/src/main/resources/dokka/scripts).
User can choose to add or override those files - stylesheets and js scripts.
Resources will be overridden when in `pluginConfiguration` block there is a resource with the same name.
## Modifying footer
Dokka supports custom messages in the footer via `footerMessage` string property on base plugin configuration.
Keep in mind that this value will be passed exactly to the output HTML, so it has to be valid and escaped correctly.
## Separating inherited members
By setting a boolean property `separateInheritedMembers` dokka will split inherited members (like functions, properties etc.)
from ones declared in viewed class. Separated members will have it's own tabs on the page.
## Merging declarations with name clashing
By setting a boolean property `mergeImplicitExpectActualDeclarations` dokka will merge declarations that do not have `expect`/`actual` keywords but have the same fully qualified name.
The declarations will be displayed on one page.
By default, it is disabled. The page names of such declaration have a prefix that is the name of source set.
### Examples
In order to override a logo and style it accordingly a css file named `logo-styles.css` is needed:
```css
.library-name a {
position: relative;
--logo-width: 100px;
margin-left: calc(var(--logo-width) + 5px);
}
.library-name a::before {
content: '';
background: url("https://upload.wikimedia.org/wikipedia/commons/9/9d/Ubuntu_logo.svg") center no-repeat;
background-size: contain;
position: absolute;
width: var(--logo-width);
height: 50px;
top: -18px;
left: calc(-1 * var(--logo-width) - 5px);
/* other styles required to make your page pretty */
}
```
For build system specific instructions please visit dedicated pages: [gradle](../applying/gradle.md#applying-plugins), [maven](../applying/maven.md#applying-plugins) and [cli](../applying/cli.md#configuration-options)
## Custom HTML pages
Templates are taken from the folder that is defined by the `templatesDir` property.
To customize HTML output, you can use the [default template](https://github.com/Kotlin/dokka/blob/master/plugins/base/src/main/resources/dokka/templates) as a starting point.
!!! note
To change page assets, you can set properties `customAssets` and `customStyleSheets`.
Assets are handled by Dokka itself, not FreeMaker.
There is a template file with predefined name `base.ftl`. It defines general design of all pages to render.
`base.ftl` can import another templates that can be set by user as well:
* `includes/header.ftl`
* `includes/footer.ftl`
* `includes/page_metadata.ftl`
* `includes/source_set_selector.ftl`.
If `templatesDir` is defined, Dokka will find a template file there.
If the file is not found, a default one will be used.
Variables given below are available to the template:
* `${pageName}` - the page name
* `${footerMessage}` - text that is set by the `footerMessage` property
* `${sourceSets}` - a nullable list of source sets, only for multi-platform pages. Each source set has `name`, `platfrom` and `filter` properties.
Also, Dokka-defined [directives](https://freemarker.apache.org/docs/ref_directive_userDefined.html) can be used:
* `<@content/>` - main content
* `<@resources/>` - scripts, stylesheets
* `<@version/>` - version ([versioning-plugin](../plugins/versioning-plugin.md) will replace this with a version navigator)
* `<@template_cmd name="...""> ...</@template_cmd>` - is used for variables that depend on the root project (such `pathToRoot`, `projectName`). They are available only inside the directive. This is processed by a multi-module task that assembles partial outputs from modules.
Example:
```
<@template_cmd name="projectName">
<span>${projectName}</span>
</@template_cmd>
```
|
