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

Warn users about opening HTML pages as files and/or opening pages without JS support #2964

Open
IgnatBeresnev opened this issue Apr 17, 2023 · 1 comment
Open

Warn users about opening HTML pages as files and/or opening pages without JS support #2964

IgnatBeresnev opened this issue Apr 17, 2023 · 1 comment
Labels
enhancement An issue for a feature or an overall improvement 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) UX An issue/PR related to the User Experience of using Dokka

Comments

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Apr 17, 2023 •
edited
Loading

Problem

If Dokka's HTML pages are opened in a browser as files (without using a web server), some of the features, such as navigation, do not work as expected - and it is visually confusing, as demonstrated by #1588 and #1513.

This might also happen if a user disables JavaScript in their browser for security reasons.

Screenshot image

Proposal

It should be possible to add an indicator, a hint or a banner (or anything else) that is easily noticeable, and that will say something like

JavaScript is not enabled on this page, some content or functionality of the website can be limited or unavailable.

If you are opening local .html files in your browser, to fix this please use a web server to host documentation, or use the IntelliJ Ultimate built-in web server for preview.

Note: JavaScript may still work while the navigation doesn't, so the no-js class cannot be used to fix it.
@IgnatBeresnev IgnatBeresnev added enhancement An issue for a feature or an overall improvement format: html An issue/PR related to Dokka's default HTML output format labels Apr 17, 2023
@IgnatBeresnev IgnatBeresnev mentioned this issue Apr 17, 2023
Merged
@IgnatBeresnev IgnatBeresnev added the UX An issue/PR related to the User Experience of using Dokka label Jul 4, 2023
@IgnatBeresnev IgnatBeresnev added the html: frontend An issue/PR that only or primarily requires frontend work (html/css) label Oct 20, 2023
@d-ambatenne d-ambatenne self-assigned this Oct 25, 2023
@IgnatBeresnev
Copy link
Member Author

Related: #1795

@IgnatBeresnev IgnatBeresnev mentioned this issue Nov 24, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement An issue for a feature or an overall improvement 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) UX An issue/PR related to the User Experience of using Dokka
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@IgnatBeresnev @d-ambatenne