invertase / docs.page

Instant Open Source docs with zero configuration.
https://docs.page
Apache License 2.0
463 stars 76 forks source link

Adding a logo to docs causes side menu to disappear #394

Open tqwewe opened 2 weeks ago

tqwewe commented 2 weeks ago

I've just added a logo to my docs page, however both in local preview and live preview, this causes the side menu to disappear completely, as well as the page title and page image.

A url where this is broken can be seen here: https://docs.page/tqwewe/kameo~docs-faq Simply removing the "logo": "..." line from the docs.json file brings back the side menu. (The fact the logo link is broken in the example url is unrelated to this issue).

Screenshot 2024-10-09 at 1 28 20 am
tqwewe commented 2 weeks ago

Oops, I've realised this is due to me specifying "logo": "url-here", instead of "logo": { "light: "url-here", "dark": "url-here" }. However there's no errors in the console or diagnostic issues shown, so this is pretty confusing, especially since the logo does in fact show correctly.

Ehesp commented 2 weeks ago

Oh this is weird! I'll check it out why that happens.

As for invalid config, I'm not sure on the best place to surface issues to the user(?)

tqwewe commented 2 weeks ago

Personally I would expect it to come up as one of the diagnostic errors when doing a live preview. The same kind of errors for when you have a link to a page that doesn't exist. But not sure how trivial this is.