⋅𝕭𝖆𝖘𝖆𝖑𝖙⋅
USER INTERFACE

Note editor

The Note editor is the main pane in the center of the interface. It displays the selected note with rendered markdown, including headings, lists, code blocks and other elements.

note-editor demo

Use j/k or arrow keys to scroll through the note. You can scroll faster with Ctrl+U and Ctrl+D for half-page jumps.

Inline images#

Images embedded in a note render inline, scaled to the note width. Basalt supports Obsidian ![[embed]] syntax, standard ![alt](path) links and remote http(s) URLs. An image renders partially as it scrolls through the viewport, and editing an embed updates the rendered image without reopening the note. GIFs render their first frame only for now.

image demo

The maximum image height is a fraction of the viewport height, set with image_max_height in the config (default 1.0). Raising it lets an image fill more of the width at the cost of more vertical space. Images need a terminal with graphics support (Kitty, iTerm2 or Sixel) and otherwise fall back to Unicode half-blocks.

Add |width or |widthxheight to size an image in pixels, matching Obsidian: ![[banner.png|200]] or ![alt|200](path). Sizes are scaled for the display so they match Obsidian's on-screen size.

Key mappings#

MappingDescription
j / ↓Move cursor down
k / ↑Move cursor up
tToggle explorer pane
TabSwitch to next pane
Shift+TabSwitch to previous pane
Ctrl+BToggle explorer pane
Ctrl+OToggle outline pane
Ctrl+UScroll up half page
Ctrl+DScroll down half page
Ctrl+Shift+↑Jump to top of note
Ctrl+Shift+↓Jump to bottom of note
gk / gjMove up / down one visible row
Enter / gdFollow the link under the cursor
] / [Move to the next / previous link

j and k move by whole line, so a soft-wrapped line counts once. gk and gj move by visible row instead.

In read view, ] and [ move the cursor from link to link and highlight the selected one. When the cursor is not on a link, Enter follows the first link on its line. These two keys are bound under read_key_bindings in [note_editor], which only apply in read view.

Following a wiki-link opens the note it names and creates that note when it does not exist. Following a plain URL opens your browser.

For text editing capabilities, see Editor (experimental).