-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
Fix docs overlapping navigation #4781
Conversation
I can also look into getting prettier to handle the 80 character wrap in markdown syntax highlighting if that would be beneficial. |
Related: prettier/prettier#2943 (unreleased) |
Thanks @SimenB, I saw that the PR was merged awhile ago. I was going to dive deeper into it, I didn't realize it wasn't released yet. |
I agree it makes sense for actual code to not get wrapped, and rather scroll horizontally 🙂 |
@rogeliog Sorry for the delay, I'll try to get this PR finished up this weekend. |
Ping, are you still working on this? |
Yes, my apologies for the delay. |
So the As for the issue in I could fix it by adding to This PR can either be merged in as is to fix the word wraps and leave the other issue to the upstream dependency, or I can write some overriding styles until the dependency is fixed. Please let me know what you would like. |
Codecov Report
@@ Coverage Diff @@
## master #4781 +/- ##
======================================
Coverage 59.9% 59.9%
======================================
Files 197 197
Lines 6549 6549
Branches 4 4
======================================
Hits 3923 3923
Misses 2626 2626 Continue to review full report at Codecov.
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Summary
NOTE: This is a work in progress as I need some clarification on some of the docs pages (See below).
There are some comments in the markdown syntax highlighter that are longer than 80 characters. This forces the documentation container to over lap the side navigation. By manually wrapping the comments at 80 characters, it resolves this issue.
Before:
There were a couple of pages that I was unsure of how you'd like the lines to be displayed. For example, the
Using with webpack
page has configs that look like the following:I feel like in this case, rather than breaking the line apart, the code block should scroll horizontally like GitHub. Similarly this would be a better fit on the
Troubleshooting
page where the following example error is shown:If you agree, I'd be happy to work on that as well.
PS: After starting the docs with
yarn start
there was some file changes that happened on 2a4eb38 which I committed separately incase I need to revert it.Test plan
After: