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.

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

Merged
merged 21 commits into from
Jun 26, 2022
Merged

Default theme design revamp #1794

merged 21 commits into from
Jun 26, 2022

Conversation

futurGH
Copy link
Contributor

@futurGH futurGH commented Nov 14, 2021

As discussed in #typedoc on Discord over the past few months, the redesigned default theme is now (mostly) ready for action!

Screenshots

Before

Old

After

New

@okikio
Copy link

okikio commented Dec 26, 2021

@futurGH How goes this?

@futurGH
Copy link
Contributor Author

futurGH commented Dec 26, 2021

@okikio Given #1812, this PR probably won't be getting anywhere for a while.

@okikio
Copy link

okikio commented Dec 26, 2021

Hmm....

@cspotcode
Copy link
Contributor

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?

@futurGH
Copy link
Contributor Author

futurGH commented Jan 23, 2022

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 assets/typedoc/components for code quality review.

@futurGH futurGH marked this pull request as ready for review January 25, 2022 04:28
@okikio
Copy link

okikio commented Jan 25, 2022

Is there a link that can be used to preview the new default theme?

@futurGH
Copy link
Contributor Author

futurGH commented Jan 25, 2022

Not currently; the best way to try it out is just to clone my fork, build locally, and run it on the example directory.

@futurGH
Copy link
Contributor Author

futurGH commented Jan 25, 2022

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.

@okikio

@okikio
Copy link

okikio commented Jan 25, 2022

@futurGH Good job, it's pretty cool

@okikio
Copy link

okikio commented Feb 8, 2022

@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.

@Gerrit0 Gerrit0 added this to the v0.23 milestone Apr 17, 2022
@Gerrit0 Gerrit0 merged commit cde2a8f into TypeStrong:master Jun 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants