mido v0.6.0

Keys

mido is keyboard first and vim-flavored. The mouse works too: the wheel scrolls, and a click follows a link or selects a row in a panel. Press ? or h inside mido for the same list, grouped the same way.

Search is smart-case: a lowercase query matches any case, and a query with a capital letter matches exactly. Before 1.0 a minor release may change keys, and every change is listed in the changelog.

The tables below are generated from the keymap in the source, so they cannot drift from what the binary does.

Reading

Key Action
j / k, ↓ / ↑, wheel Scroll one line
Ctrl-d / Ctrl-u Half page down / up
Ctrl-f / Ctrl-b, Space Page down / up
g / G Top / bottom
t Table of contents
i Show or hide images
m Expand or collapse the front matter
r Reload the file

Panels and focus

Key Action
b / o Toggle the files / outline panel
f Focus mode: hide the panels, full width
Tab / Shift-Tab Cycle focus between the panes
Tab then ← / → Move focus in that direction
l Focus the pane to the right
j / k, ↓ / ↑ in a panel Move, Enter opens or returns
Space, ← / → in a panel Fold, collapse / expand a folder or section
- / = in a panel Fold all / unfold all
T in the files panel Show titles instead of file names
Key Action
] / [ Select the next / previous link
Enter, click Follow the selected link or open a footnote
H / L Back / forward through visited pages
Ctrl-p Find a file in the folder
y Copy the selected link or a code block

Search and editing

Key Action
/ Search, Enter to keep, Esc to cancel
F Search every file in the folder
n / N Next / previous match
e Edit the file in mido
v Edit with a live preview
s In the split, sync scrolling on or off
< / > In the split, editor narrower / wider
E Edit the file in $EDITOR, reload on return

Help and quit

Key Action
?, h This help
q Quit

In the editor

Key Action
Ctrl-s Save
F1 This help
Esc Back to reading, or to the preview
Ctrl-z / Ctrl-y Undo / redo
Ctrl-x / Ctrl-c Cut / copy the selection
Ctrl-v Paste
Ctrl-a Select everything
Ctrl-f Find in the file, Enter keeps, Esc cancels
Ctrl-n / Ctrl-p Next / previous match
Ctrl-t Check a task, or make the line one
Ctrl-e Show or hide the live preview
Shift with a move Select, and so does a drag
Ctrl-← / Ctrl-→ Word left / right, or Alt-b / Alt-f
Ctrl-↑ / Ctrl-↓ Paragraph up / down
Home / End Line start / end
Ctrl-Home / Ctrl-End Top / bottom
Alt-Backspace Delete a word back, or Ctrl-w
Alt-Delete Delete a word forward
Enter New line, continuing a list, task or quote
Tab / Shift-Tab Nest a list item deeper / shallower
Backtick, * Typed in pairs, or wrap the selection

Remapping

Every key above that is not fixed can be bound in the [keys] table of the config file. An action listed there loses its default keys, and a key it takes is removed from the action that had it. An empty list unbinds the action.

[keys]
scroll_down = ["j", "down", "ctrl-n"]
quit = ["q", "ctrl-q"]
images = []

Keys are written as a single character, which keeps its case, a name (space, enter, esc, tab, backspace, up, down, left, right, pageup, pagedown, home, end, f1 to f12), or either with a ctrl- or alt- prefix. Esc, Tab, Ctrl-c and the panel keys are fixed. Enter, PgDn, PgUp, Home and End scroll, page and jump unless a binding takes them.

The editor's actions have keys of their own, apart from the reader's, so ctrl-f finds in the editor and pages down in the reader. They need a ctrl- or alt- prefix or a named key, since a plain letter types, and in the editor Ctrl-c copies.

Action Default What it does
scroll_down j, ↓ Scroll down one line, move down in a panel or list
scroll_up k, ↑ Scroll up one line, move up in a panel or list
half_page_down Ctrl-d Half page down
half_page_up Ctrl-u Half page up
page_down Ctrl-f, Space Page down
page_up Ctrl-b Page up
top g Go to the top
bottom G Go to the bottom
toc t Table of contents
images i Show or hide images
front_matter m Expand or collapse the front matter
reload r Reload the file
files b Toggle the files panel
outline o Toggle the outline panel
focus_mode f Focus mode
focus_right l Focus the pane to the right
next_link ] Select the next link
prev_link [ Select the previous link
back H Back through visited pages
forward L Forward through visited pages
finder Ctrl-p Find a file in the folder
yank y Copy the selected link, or a code block on screen
search_files F Search every file in the folder
search / Search
next_match n Next match
prev_match N Previous match
edit E Edit the file in $EDITOR
editor e Edit the file in mido's own editor
split v Edit with a live preview, or close the preview
sync s In the split, scroll the editor and preview together or apart
split_narrower < In the split, give the editor less room
split_wider > In the split, give the editor more room
help ?, h Key help
quit q Quit
save Ctrl-s Save the file
undo Ctrl-z Undo
redo Ctrl-y Redo
cut Ctrl-x Cut the selection
copy Ctrl-c Copy the selection, to the system clipboard too
paste Ctrl-v Paste what was cut or copied
select_all Ctrl-a Select everything
find Ctrl-f Find in the file
find_next Ctrl-n Next match
find_prev Ctrl-p Previous match
toggle_task Ctrl-t Check or uncheck a task, or make the line one
preview Ctrl-e Show or hide the live preview beside the editor