aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-08-25 20:55:41 +0200
committerGitHub <noreply@github.com>2021-08-25 20:55:41 +0200
commitf2adc0a50462a63f7e1901db2e58077001acd622 (patch)
treea0a21d3c99b2d8cbe77ebf95d865aabd36d6598f /docs
parent939cbcd4d867961516da71f7c55d037ec88cb7f3 (diff)
parentefc9f92b0ac083c73ac494c95b530305ac04115a (diff)
downloaddokka-f2adc0a50462a63f7e1901db2e58077001acd622.tar.gz
dokka-f2adc0a50462a63f7e1901db2e58077001acd622.tar.bz2
dokka-f2adc0a50462a63f7e1901db2e58077001acd622.zip
Merge pull request #2066 from Kotlin/webhelp-like-frontend
Webhelp like frontend
Diffstat (limited to 'docs')
-rw-r--r--docs/src/doc/docs/user_guide/base-specific/frontend.md13
1 files changed, 2 insertions, 11 deletions
diff --git a/docs/src/doc/docs/user_guide/base-specific/frontend.md b/docs/src/doc/docs/user_guide/base-specific/frontend.md
index 62f72af1..63146013 100644
--- a/docs/src/doc/docs/user_guide/base-specific/frontend.md
+++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md
@@ -24,7 +24,6 @@ Dokka uses 3 stylesheets:
* `style.css` - main css file responsible for styling the page
* `jetbrains-mono.css` - fonts used across dokka
-* `logo-styles.css` - logo styling
User can choose to add or override those files.
Resources will be overridden when in `pluginConfiguration` block there is a resource with the same name.
@@ -32,20 +31,12 @@ Resources will be overridden when in `pluginConfiguration` block there is a reso
## 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 pased exactly to the output html, so it has to be valid and escaped correctly.
+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.
-### Examples
-In order to override a logo and style it accordingly a simple css file named `logo-styles.css` is needed:
-```css
-#logo {
- background-image: url('https://upload.wikimedia.org/wikipedia/commons/9/9d/Ubuntu_logo.svg');
- /* other styles required to make your page pretty */
-}
-```
-For build system specific instructions please visit dedicated pages: [gradle](../gradle/usage.md#Applying plugins), [maven](../maven/usage.md#Applying plugins) and [cli](../cli/usage.md#Configuration options)
+For build system specific instructions please visit dedicated pages: [gradle](../gradle/usage.md#Applying plugins), [maven](../maven/usage.md#Applying plugins) and [cli](../cli/usage.md#Configuration options) \ No newline at end of file