Fix off-by-one rendering of all highlighted lines in the docs! #4221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All of the highlighted lines in the docs are rendered one line above where they ought to be. This PR fixes the issue. A few examples: * https://docs.viam.com/tutorials/projects/helmet/ * https://docs.viam.com/operate/get-started/other-hardware/hello-world-module/#implement-the-api-methods (open the Go tab and look at the example in step 2; this example notably uses the first branch of the conditional logic, which sets an offset starting line) * https://docs.viam.com/dev/reference/sdks/connectivity/ (all tabs) There is probably a better way to do this -- for instance, I'm not convinced we need so much custom logic for code examples at all -- but this fix fixes the problem without changing all of the variables we use to configure code snippets, and without ripping out any internals like prism.js. Once I have a little more experience with our infra, I'll give simplifying the code-block handling a shot... but for now, this fixes a very visible issue in the docs.
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
viambot
added
the
safe to build
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All of the highlighted lines in the docs are rendered one line above where they ought to be. This PR fixes the issue.
A few examples:
There is probably a better way to do this -- for instance, I'm not convinced we need so much custom logic for code examples at all -- but this fix fixes the problem without changing all of the variables we use to configure code snippets, and without ripping out any internals like prism.js. Once I have a little more experience with our infra, I'll give simplifying the code-block handling a shot... but for now, this fixes a very visible issue in the docs.
For more information about why data-line-offset fixes this issue, see the prism.js line-highlight docs.