diff options
Diffstat (limited to 'docs/src/doc')
| -rw-r--r-- | docs/src/doc/docs/user_guide/base-specific/frontend.md | 14 |
1 files changed, 7 insertions, 7 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 ecbd6964..f2dd31b0 100644 --- a/docs/src/doc/docs/user_guide/base-specific/frontend.md +++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md @@ -85,15 +85,15 @@ Currently, there is only one template file with predefined name `base.ftl`. It d If `templatesDir` is defined, Dokka will find the `base.ftl` file there. 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. + * `${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](https://kotlin.github.io/dokka/1.6.10/user_guide/versioning/versioning/) 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. + * `<@content/>` - main content + * `<@resources/>` - scripts, stylesheets + * `<@version/>` - version ([versioning-plugin](https://kotlin.github.io/dokka/1.6.10/user_guide/versioning/versioning/) 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"> |