diff options
Diffstat (limited to 'examples/gradle/dokka-customFormat-example/README.md')
| -rw-r--r-- | examples/gradle/dokka-customFormat-example/README.md | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/examples/gradle/dokka-customFormat-example/README.md b/examples/gradle/dokka-customFormat-example/README.md index 00dd668c..a25cd80e 100644 --- a/examples/gradle/dokka-customFormat-example/README.md +++ b/examples/gradle/dokka-customFormat-example/README.md @@ -1,24 +1,17 @@ ## Dokka custom format example -This example demonstrates a few things: +This example demonstrates how to override `.css` styles and add custom images as assets, allowing +you to change the logo used in the header. -1. How to override css styles and add custom images. -2. How to change logo used in the header. -3. How to register a custom `Dokka` task with its own independent configuration. +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). -### Running + -`dokkaCustomFormat` task has been created in the buildscript of this example project with a few configuration changes. +### Running -In order to see the full effect of these changes, run `dokkaCustomFormat` task from your IDE or execute -the following command: +Run `dokkaHtml` task to generate documentation with the custom logo in place: ```bash -./gradlew clean dokkaCustomFormat +./gradlew dokkaHtml ``` - ---- - -If you run any other `Dokka` task, such as `dokkaHtml`, you'll see vanilla `Dokka` without any alterations. -This is because changes to configuration are applied only within `dokkaCustomFormat` task. This can be useful -if you want to generate multiple versions of documentation with different configuration settings. |