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.

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

Verify CSS styles and the icon of the homepage link button #3300

Closed
IgnatBeresnev opened this issue Oct 30, 2023 · 2 comments · Fixed by #3410
Closed

Verify CSS styles and the icon of the homepage link button #3300

IgnatBeresnev opened this issue Oct 30, 2023 · 2 comments · Fixed by #3410
Assignees
Labels
format: html An issue/PR related to Dokka's default HTML output format html: frontend An issue/PR that only or primarily requires frontend work (html/css) tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development
Milestone

Comments

@IgnatBeresnev
Copy link
Member

#3235 added a homepage link with an icon to the HTML format, as per #2948.

The current icon is a royalty-free placeholder, so we need to see if there's a preferred icon-pack within JetBrains / Kotlin, and change the icon if needed.

The styles also need to be verified, as they were mostly made to just work. There might be issues with scaling and/or the mobile layout, but we lack the expertise to be certain.

@IgnatBeresnev IgnatBeresnev added format: html An issue/PR related to Dokka's default HTML output format tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life html: frontend An issue/PR that only or primarily requires frontend work (html/css) labels Oct 30, 2023
@IgnatBeresnev IgnatBeresnev added this to the Dokka 1.9.20 milestone Oct 30, 2023
@IgnatBeresnev IgnatBeresnev self-assigned this Oct 30, 2023
@IgnatBeresnev
Copy link
Member Author

IgnatBeresnev commented Nov 24, 2023

Grooming notes:

  • There is no documentation on how to use this feature yet, so I'll need to show how to "activate" it, which will take ~15 minutes and can be async (in Slack)
  • Need to choose the new icon for the home link
  • Need to verify CSS styles, make sure they are mobile friendly and the icon is where it's supposed to be
  • The icon is customizable by the users (comes by default in Dokka), so custom icons need to scale properly.
    • We can give guidance to our users when it comes to aspect ratio or even ideal size of the icon, but it should be reasonably flexible.
  • Need to onboard Elena how to customize the icon to test it

@IgnatBeresnev IgnatBeresnev added the topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development label Nov 24, 2023
@atyrin
Copy link
Contributor

atyrin commented Jan 18, 2024

Customization is possible with such steps

  1. Add a custom icon to a dokka project (e.g. to css/homeIcon.svg)
  2. Customize icon name in custom css file (e.g. css/homeIcon.css)
.navigation-controls--homepage {
    background-image: url("../images/homeIcon.svg");
}
  1. Pass custom asset and style sheet to dokka in the build script:
pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
        customAssets = listOf(file("css/homeIcon.svg"))
        customStyleSheets = listOf(file("css/homeIcon.css"))
}

N.B. do not forget about homepageLink field to add a button to navigation bar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
format: html An issue/PR related to Dokka's default HTML output format html: frontend An issue/PR that only or primarily requires frontend work (html/css) tech-debt A technical issue that is not observable by the users, but improves maintainers quality of life topic: frontend onboarding An issue that could be used to onboard team members specializing in frontend development
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants