diff options
author | Jesse Duffield <jessedduffield@gmail.com> | 2023-05-21 11:13:02 +1000 |
---|---|---|
committer | Jesse Duffield <jessedduffield@gmail.com> | 2023-05-21 11:31:29 +1000 |
commit | 3eed99716105481dffddc9a74db0d444a9c469a2 (patch) | |
tree | 22a7ec053c0a9d82b6af8a09d2f60fdf249c6840 /pkg/cheatsheet | |
parent | 526d8a8a7630a963bf5ff64b553f233264d63d65 (diff) |
Update cheatsheet
Now that we're using the angle-bracket syntax everywhere for consistency, we need to escape
the angle brackets in the markdown of the cheatsheets.
Diffstat (limited to 'pkg/cheatsheet')
-rw-r--r-- | pkg/cheatsheet/generate.go | 25 |
1 files changed, 18 insertions, 7 deletions
diff --git a/pkg/cheatsheet/generate.go b/pkg/cheatsheet/generate.go index ee2538c1f..ec2c84dbd 100644 --- a/pkg/cheatsheet/generate.go +++ b/pkg/cheatsheet/generate.go @@ -12,6 +12,7 @@ import ( "fmt" "log" "os" + "strings" "github.com/jesseduffield/generics/maps" "github.com/jesseduffield/generics/slices" @@ -183,6 +184,8 @@ func getHeader(binding *types.Binding, tr *i18n.TranslationSet) header { func formatSections(tr *i18n.TranslationSet, bindingSections []*bindingSection) string { content := fmt.Sprintf("# Lazygit %s\n", tr.Keybindings) + content += fmt.Sprintf("\n%s\n", italicize(tr.KeybindingsLegend)) + for _, section := range bindingSections { content += formatTitle(section.title) content += "<pre>\n" @@ -200,13 +203,21 @@ func formatTitle(title string) string { } func formatBinding(binding *types.Binding) string { + result := fmt.Sprintf(" <kbd>%s</kbd>: %s", escapeAngleBrackets(keybindings.LabelFromKey(binding.Key)), binding.Description) if binding.Alternative != "" { - return fmt.Sprintf( - " <kbd>%s</kbd>: %s (%s)\n", - keybindings.LabelFromKey(binding.Key), - binding.Description, - binding.Alternative, - ) + result += fmt.Sprintf(" (%s)", binding.Alternative) } - return fmt.Sprintf(" <kbd>%s</kbd>: %s\n", keybindings.LabelFromKey(binding.Key), binding.Description) + result += "\n" + + return result +} + +func escapeAngleBrackets(str string) string { + result := strings.ReplaceAll(str, ">", ">") + result = strings.ReplaceAll(result, "<", "<") + return result +} + +func italicize(str string) string { + return fmt.Sprintf("_%s_", str) } |