Skip to content

docs(readme): document key binding for sticky sidebar toggle#49

Merged
rtalexk merged 1 commit into
mainfrom
docs/sticky-sidebar-keybinding
May 22, 2026
Merged

docs(readme): document key binding for sticky sidebar toggle#49
rtalexk merged 1 commit into
mainfrom
docs/sticky-sidebar-keybinding

Conversation

@rtalexk

@rtalexk rtalexk commented May 22, 2026

Copy link
Copy Markdown
Owner

Context

The sticky sidebar is toggled with demux sidebar toggle, but the README never showed how to bind that command to a key. Driving it from a cmd chord is non-obvious: terminals do not forward cmd shortcuts to tmux, so the terminal emulator has to translate the chord into an escape sequence tmux can catch.

What does this PR do

Adds a "Bind a key to toggle" subsection under ## Sticky sidebar:

  • tmux side: bind-key -n M-E run-shell "demux sidebar toggle"
  • terminal side (Ghostty): keybind = cmd+shift+e=text:\x1bE
  • explains that \x1bE is Alt-E (M-E), the sequence the tmux binding catches

Docs-only change; no code touched.

Manual QA

  • Rendered the updated README and confirmed the new "Bind a key to toggle" subsection appears under "Sticky sidebar", after the Lifecycle block, with both code blocks formatting correctly.
  • Verified the documented binding works end to end: with bind-key -n M-E run-shell "demux sidebar toggle" in ~/.tmux.conf and keybind = cmd+shift+e=text:\x1bE in the Ghostty config, pressing CMD + Shift + E toggles the sticky sidebar.

Add a "Bind a key to toggle" subsection explaining how to wire
`demux sidebar toggle` to a tmux key, and how to drive it from a
cmd chord by mapping the terminal emulator to the M-E escape
sequence (Ghostty example included).
@rtalexk rtalexk merged commit e8c8197 into main May 22, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant