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

Change syntax highlighting in documentation site #910

Open
paulwongx opened this issue Feb 2, 2023 · 2 comments
Open

Change syntax highlighting in documentation site #910

paulwongx opened this issue Feb 2, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@paulwongx
Copy link

For some reason, reading the react-hook-form docs is always very tiring and it feels draining after reading a few pages. I always thought it was me but I realized today the color syntax highlighting is totally off.

All the unimportant things are highlighted in red and yellow and everything important to distinguish is all in white. This causes a tremendous amount of cognitive load and energy to process the docs. Can we change the syntax so it uses a standard syntax highlighting? Like tailwind docs or zustand docs?

For example, the code below:

  • Red: The most unimportant things that you don't need to focus on. All of these are generic too.
  • Yellow: Slightly more important than red, but absolutely nothing that you need to focus on to understand the code
  • White: Everything that is unique and important to understand the code

This is an absolute anti-pattern. So please, can we change the syntax highlighting so millions of people's lives are easier?
image

@bluebill1049 bluebill1049 added the enhancement New feature or request label Feb 2, 2023
@bluebill1049
Copy link
Member

You can switch to light mode if that helps. or feel free to play around with the primsajs and send us a PR to improve.

@haykerman
Copy link

Adding to this issue. If possible, please, change the font to be Fira Code or something similar. Will make it easier to read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants