Fix broken markdown in auto-generated keybindings documentation #4690
Conversation
This file contains hidden or 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
KEY60228
force-pushed
the
fix/broken-markdown-table
branch
from
b768cb3 to
31c3385
Compare
stefanhaller
reviewed
Jul 6, 2025
pkg/cheatsheet/generate.go
Outdated
Comment on lines
225
to
226
| tooltip := strings.ReplaceAll(binding.Tooltip, "\n\n", "<br><br>") | ||
| tooltip = strings.ReplaceAll(tooltip, "\n", "<br>") |
There was a problem hiding this comment.
Why do we need both of these? As far as I can tell, the second ReplaceAll is all we need.
There was a problem hiding this comment.
You're right, I screwed up! 🤦
There was a problem hiding this comment.
Thanks, I squashed them into one.
For your next PR, you may want to look into fixup commits for cases like this. 😄
KEY60228
changed the title
KEY60228
force-pushed
the
fix/broken-markdown-table
branch
from
3aefe0c to
9fb667e
Compare
KEY60228
force-pushed
the
fix/broken-markdown-table
branch
from
9fb667e to
d0c4b65
Compare
stefanhaller
force-pushed
the
fix/broken-markdown-table
branch
from
d0c4b65 to
b11da41
Compare
stefanhaller
changed the title
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Aug 4, 2025
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [jesseduffield/lazygit](https://github.com/jesseduffield/lazygit) | minor | `v0.53.0` -> `v0.54.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>jesseduffield/lazygit (jesseduffield/lazygit)</summary> ### [`v0.54.0`](https://github.com/jesseduffield/lazygit/releases/tag/v0.54.0) [Compare Source](jesseduffield/lazygit@v0.53.0...v0.54.0) <!-- Release notes generated using configuration in .github/release.yml at v0.54.0 --> Again we don't have any major new features this time (unless you count the support for alt-backspace for deleting words in the commit message editor, which is one of my favorite additions), but lots of smaller quality-of-life improvements and bug fixes. The most notable one is probably the fix for the stale index.lock problem, which was a very long-standing bug that seemed to affect some users much more than others for some reason. #### What's Changed ##### Enhancements 🔥 - Add confirmation for hard reset by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4704 - Provide user config defaults for UI-changeable settings by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4717 - Improve mouse handling of suggestions panel by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4726 - Add new command "Checkout previous branch" by [@​kyu08](https://github.com/kyu08) in jesseduffield/lazygit#4728 - Add confirmation for nuking the working tree by [@​DawidPietrykowski](https://github.com/DawidPietrykowski) in jesseduffield/lazygit#4727 - Support Alt+Backspace for word deletion in text areas by [@​rtzll](https://github.com/rtzll) in jesseduffield/lazygit#4741 - Don't use hunk mode for added or deleted files even when useHunkModeInStagingView config is on by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4758 - Show \[0] keybinding in main view title by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4754 - Draw divergence from base branch right-aligned in branches view by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4785 - Enable hunk staging mode by default by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4780 ##### Fixes 🔧 - Fix scrolling hunk into view when selecting next hunk by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4709 - Fix stale main view content when entering/exiting filtering view by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4719 - Detect double-clicks properly by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4725 - Fix commit searching during rebase or in divergence from upstream view by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4730 - Fix amending commits whose commit message is empty by [@​aidancz](https://github.com/aidancz) in jesseduffield/lazygit#4732 - Several small fixes to filtering mode (by path or author) by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4749 - Show diff for renamed file when filtering by path by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4750 - Allow rewording or dropping commits in filtering mode by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4756 - Fix index out of bounds panic when repository has massive tags by [@​chojs23](https://github.com/chojs23) in jesseduffield/lazygit#4776 - When pressing `a` to stage all files, don't include untracked files when showing only tracked files by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4779 - Fix commit hash colors when filtering by path or aythor by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4789 - Improve temp dir handling by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4784 - Terminate git processes more gracefully to avoid the stale index.lock problem by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4782 ##### Maintenance ⚙️ - Raise sponsors MRs as a draft by [@​jesseduffield](https://github.com/jesseduffield) in jesseduffield/lazygit#4694 - Update the peter-evans/create-pull-request action to v7 by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4695 - Update release workflow by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4703 - Clean up the .gitignore file by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4706 - Remove unused code and texts by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4715 - Remove deprecated edit configs by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4716 - Bump minimum required git version to 2.32 by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4718 - Use a better way of pinning the version of golangci-lint by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4733 - Make the minimum required git version a placeholder in the error text by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4778 - refactor: use slices.Equal to simplify code by [@​jishudashu](https://github.com/jishudashu) in jesseduffield/lazygit#4764 ##### Docs 📖 - Fix broken markdown in auto-generated keybindings documentation by [@​KEY60228](https://github.com/KEY60228) in jesseduffield/lazygit#4690 - Remove the homebrew tap from the readme by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4705 ##### I18n 🌎 - Update translations from Crowdin by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4791 ##### Performance Improvements 📊 - Fix performance regression on startup in repos with many tags by [@​stefanhaller](https://github.com/stefanhaller) in jesseduffield/lazygit#4777 #### New Contributors - [@​KEY60228](https://github.com/KEY60228) made their first contribution in jesseduffield/lazygit#4690 - [@​DawidPietrykowski](https://github.com/DawidPietrykowski) made their first contribution in jesseduffield/lazygit#4727 - [@​rtzll](https://github.com/rtzll) made their first contribution in jesseduffield/lazygit#4741 - [@​chojs23](https://github.com/chojs23) made their first contribution in jesseduffield/lazygit#4776 - [@​jishudashu](https://github.com/jishudashu) made their first contribution in jesseduffield/lazygit#4764 **Full Changelog**: jesseduffield/lazygit@v0.53.0...v0.54.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS40Ni43IiwidXBkYXRlZEluVmVyIjoiNDEuNDYuNyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR fixes the broken markdown table formatting in the auto-generated keybindings documentation files by properly escaping newlines in tooltips.
Issue: #4689
go generate ./...)Tests have been added/updated (see here for the integration test guide)If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)