docs(gen_help_html.lua): fix broken pre text, and handle linewrap #28755
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
|
This PR has a slightly different result than the "word-break" solution #28678:
but it should be a pretty reasonable rendering. Also, codeblocks will now look like "nowrap":
instead of, for example: https://neovim.io/doc/user/dev_vimpatch.html#dev-vimpatch-list-management |
|
Apropos: while you're at it, can you add handling for the nodes
(Not a blocker; just wanted to make a note for the record.) |
justinmk
reviewed
May 15, 2024
Problem: - Since neovim#28678, pre-formatted text in the online documentation do not render whitespaces correctly: should be pre-like text, but shown like normal paragraph (see neovim#28754). - Code blocks with long lines should not be wrapped (e.g. see |dev-vimpatch-list-management|). Solution: - Use `white-space: pre-wrap`. Compared to `white-space: pre`, this option will make long lines including a very long URL wrapped. This properly fixes neovim#28754 and neovim#28678. - Use horizontal scrollbar for the code blocks that are horizontally too long, instead of wrapping text. This will make the code easy to read while the pre-text block not interfering with the navigation bar.
|
Anything missing before 0.10? |
|
(The 0.10 release is unrelated because the docs are always generated from HEAD.) |
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.
Problem:
Since docs(gen_help_html.lua): wrap legacy help at word-boundary #28678, pre-formatted text in the online documentation do not
render whitespaces correctly: should be pre-like text, but shown like
normal paragraph (see Online documentation contains strange wrapping #28754).
Code blocks with long lines should not be wrapped (e.g. see
|dev-vimpatch-list-management|).
Solution:
Use
white-space: pre-wrap. Compared towhite-space: pre, thisoption will make long lines including a very long URL wrapped.
This properly fixes Online documentation contains strange wrapping #28754 as well as docs(gen_help_html.lua): wrap legacy help at word-boundary #28678.
Use horizontal scrollbar for the code blocks that are horizontally too
long, instead of wrapping text. This will make the code easy to read
while the pre-text block not interfering with the navigation bar.