search

func-godot / func_godot_docs

Documentation for the FuncGodot plugin.
MIT License
4 stars 4 forks source link

Add light mode colors #11

Open ckaiser opened 1 month ago

ckaiser commented 1 month ago

Hi! I was editing the documentation CSS for my own personal use (light text on a dark background nukes my eyes something fierce) so I figured I'd contribute it back to the project to help any other weirdos like myself.

It's using the default CSS color-scheme preference which should pick up the system scheme automatically, although I could also add a button toggle somewhere if necessary.

Here's a comparison:

https://github.com/func-godot/func_godot_docs/assets/138269/a0ba15d1-3d88-4b11-a1fa-86eff4f884fa

RisingThumb commented 1 month ago

Could you also try different link colours for the light mode? Maybe the same blue colour as the Godot icon? The contrast for links is pretty bad for the navbar imo. Apart from that looks visually good to me.

Can you also include examples of what <pre>, <table> and <code> blocks end up looking like? You can see these on class reference and in code snippets throughout the docs

A button toggle would also be nice if it's an easy addition

RhapsodyInGeek commented 1 month ago

I could also add a button toggle somewhere if necessary.

Yes, this would be necessary. The "dark" mode should be the default as well, as the color scheme is also part of the plugin's "branding" (all of the colors used are Quake palette colors).

I imagine since it's just CSS it should work offline locally with no problems as well?

ckaiser commented 1 month ago

Alright, I'll switch it around to just use a class and a button. Question: is there any particular reason as to why the docs are using iframes? They're kinda janky for this since they all have their own DOM and it makes cascading CSS and stuff like navigating to parts of the documentation in new tabs a bit cumbersome. Have you considered using a site generator like Hugo to generate the HTML? Would make it easier to write too since you can just use markdown instead of raw html.

RisingThumb commented 1 month ago

See #5 and #6 about this. The short of it is that it shouldn't be a single mega html file, it should still run offline and locally, and ideally it shouldn't require running any more dependencies or extra build steps.