[WIP] JuliaDynamics documentation theme #127
Conversation
|
The changes here seem to have overridden the background colour for code blocks - this looks especially bad 😆 |
|
Yeap @asinghvi17 I know. I don't know how to fix it, I've asked @mortenpi and a reply is pending. I've overwritten the "correct" .css command but it didn't affect it. |
|
Also, the URLs on the front page seem broken. |
|
Looking at the first link (is this before or after the makeover?) - Personal opinion: I'm not a big fan of this: too many strong colours, poor contrast, sidebar is particularly low contrast, font isn't great for reading, pale green headings get lost but should be catching the eye. I presume the code samples have gone wrong? The dark theme is better - but the admonitions are a bit distracting when you're trying to read (the main purpose?). OK for serious warnings perhaps... I like purple. But small intense accents are better than huge expanses or wide headers... There's way too much of it for me. If you provide an alternative monochrome look I'll definitely be using it. :) |
|
Damn, this is so harsh I will cry! No just kidding, this isn't nowhere near the final product and if noone likes it it goes in the garbage anyway. I've tried to use purple color for the sidebar, because I want to mirror the look of the original doc of DynamicalSystems.jl (and also DynamicalBilliards.jl) here: https://juliadynamics.github.io/DynamicalSystems.jl/dev/ , but you think its too much? In the Material case, the purple bar is much smaller in size, but I think one cannot achieve a similar effect with Documenter. For the admonitions, I guess you have a point, there are too many in the start.
What is the poor contrast? between purple and white, or between the side bar and the main part? About the font, sure, feel free to suggest better alternatives for both code and normal text. These are the fonts used in the DynamicalSystems.jl docs, and I haven't had any trouble reading that so far... |
|
Sorry if I sounded a bit harsh! 😿The previous docs are better as far as contrast is concerned. It's worth remembering that design is for others not just for us - perhaps people have weaker eyes or colour blindness or whatever. You can test sonethings online - eg here: https://color.a11y.com/Contrast/ . |
|
DOn't worry, I really appreciate your critisism, and the harsher the better. THe old website unfortunately is made with a Python package that always brings problems into building the docs both online as well as locally... So a move to Documenter will make things easier. But they won't be as cool looking... If you have some spare time at any point please feel welcomed to suggest better fonts, and better style choices. In the mean time, I will try to make the left side bar to not be full purple, but to only have the purple at e.g. the currently selected section. |
|
In the latest commit I've decreased saturation significantly, and decreased the total amount of color used to only 4 (besides the admonition blocks). I tried other fonts as well, but MOntserrat always appeard more readable to me. I've tried e.g. Quicksand, Lora, Lato. At the moment a documenter bug does not correctly register where the colors of the text of the sidebar should come from. |
|
The font color for subsections in the sidebar is white...I can't read it at all with the white background. May want to change them to black? Edit: nvm, just read your comment, lol. Looking good otherwise (though I think the vivid purple of the sidebar is a little too much) |
It is supposed to be black but documenter fail to configure it. But okay, you have a point, for now I'll make all black. |
|
:) |
|
The Manifest might need to be removed before merging? At the least, it should be fixed to the |
|
This PR won't get merged anyway, don't worry. It is only a test. The docstyling files will be centrally distributed from another repo in JuliaDynamics |
|
Actually, there is one bug on dark theme: |
|
This is good to go. I'll wait for the Documenter PRs to be merged and then I'll put this in effect. In the meantime, everyone is invited to also look at the dark theme and give feedback. |
Okay, this PR attempts to create a Documenter.jl theme that will be subsequently used in all packages of JuliaDynamics. I invite everyone to provide feedback and comments and suggestions etc. The documentation can be previewed here:
https://juliadynamics.github.io/DrWatson.jl/previews/PR127/
I guess if there is one thing that is non-negotiable, its the color purple... :D
The theme should be compared with e.g. the theme of DynamicalSystems.jl (as it will get the same theme as well): https://juliadynamics.github.io/DynamicalSystems.jl/dev/