aboutsummaryrefslogtreecommitdiff
path: root/examples/gradle/dokka-customFormat-example/README.md
blob: a25cd80e521c299fffc230d8678d9837b7d222c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
## Dokka custom format example

This example demonstrates how to override `.css` styles and add custom images as assets, allowing
you to change the logo used in the header.

You can see up-to-date documentation generated for this example on 
[GitHub Pages](https://kotlin.github.io/dokka/examples/dokka-customFormat-example/html/index.html).

![screenshot demonstration of output](demo.png)

### Running

Run `dokkaHtml` task to generate documentation with the custom logo in place:

```bash
./gradlew dokkaHtml
```