Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix rendering issues #2389

Merged
merged 1 commit into from Mar 15, 2022
Merged

Fix rendering issues #2389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/src/doc/docs/user_guide/base-specific/frontend.md
View file
Open in desktop
Expand Up @@ -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">
Expand Down
2 changes: 1 addition & 1 deletion plugins/base/frontend/src/main/components/search/search.scss
View file
Open in desktop
Expand Up @@ -3,7 +3,7 @@ $secondary-font-color: hsla(0, 0%, 100%, 0.6);

.search {
button {
margin-top: 3px;
margin-top: 10px;

cursor: pointer;

Expand Down
4 changes: 2 additions & 2 deletions plugins/base/src/main/resources/dokka/templates/base.ftl
View file
Open in desktop
Expand Up @@ -35,15 +35,15 @@ if(savedDarkMode === true){
<@version/>
</div>
<div class="pull-right d-flex">
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
<#if sourceSets??>
<div class="filter-section" id="filter-section">
<#list sourceSets as ss>
<button class="platform-tag platform-selector ${ss.platform}-like" data-active="" data-filter="${ss.filter}">${ss.name}</button>
</#list>
</div>
</#if>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
Expand Down