-
-
Notifications
You must be signed in to change notification settings - Fork 723
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
Default theme design revamp #1794
Conversation
@futurGH How goes this? |
Hmm.... |
I skimmed the code changes. Is there anything in particular you would like review feedback on? I plan to clone this branch locally and run it against a sample codebase, comparing the output to the old version. I see 4 outstanding checkboxes in the issue. Do you still want to do them as part of this PR, or do you think it's best to extract them into separate issues? |
I think it would be best to separate them out; the "nice to have"s aren't that difficult to implement on their own, and the code block styling should definitely be a separate issue. As for specific feedback, I'm really just looking for thoughts on usability and accessibility of the new design compared to TypeDoc's current design. I'd appreciate a quick look over my changes in the default theme's |
Is there a link that can be used to preview the new default theme? |
Not currently; the best way to try it out is just to clone my fork, build locally, and run it on the example directory. |
c59755e
to
c2e9975
Compare
Also removed icon legend from the footer. As such, the hideLegend option now serves no purpose and should be removed.
Slightly more consistent heading sizes, better breakpoints for medium (728px-1280px) devices, & general variable cleanup
c2e9975
to
0065d97
Compare
Quick update: you can now view the example documentation rendered with the redesign at https://futurgh.github.io/typedoc/redesign - pre-redesign is also available at https://futurgh.github.io/typedoc/original for reference. |
@futurGH Good job, it's pretty cool |
@futurGH I think you should have the dark mode toggle be immediately accessible, it just feels as though having it easier to reach would be better. Also, there is no menu toggle available on mobile, so, if you toggle the menu, you currently can't re-toggle it to hide the menu. |
As discussed in
#typedoc
on Discord over the past few months, the redesigned default theme is now (mostly) ready for action!Screenshots
Before
After