aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Aman <marcin.aman@gmail.com>2021-01-14 16:51:25 +0100
committerGitHub <noreply@github.com>2021-01-14 16:51:25 +0100
commitc04295aa7f0bdad9eb7b27e3dbc2b2c90094da86 (patch)
tree92952ccc055b3d466e85c9998d6ea5349d5c1ce2 /docs
parent4a0af562bc86ebb84ecd8a90f690214c79df8d40 (diff)
downloaddokka-c04295aa7f0bdad9eb7b27e3dbc2b2c90094da86.tar.gz
dokka-c04295aa7f0bdad9eb7b27e3dbc2b2c90094da86.tar.bz2
dokka-c04295aa7f0bdad9eb7b27e3dbc2b2c90094da86.zip
Footer customisation (#1691)
Diffstat (limited to 'docs')
-rw-r--r--docs/src/doc/docs/user_guide/base-specific/frontend.md14
1 files changed, 14 insertions, 0 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 11c0c786..a9fd660f 100644
--- a/docs/src/doc/docs/user_guide/base-specific/frontend.md
+++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md
@@ -1,5 +1,9 @@
# Configuration specific to HTML format
+!!! 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.
@@ -19,6 +23,16 @@ Dokka uses 3 stylesheets:
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.
+## 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.
+
+## 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