> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otter-shell.org/llms.txt
> Use this file to discover all available pages before exploring further.

# otter-note

> Pin markdown notes to a layer-shell surface. Toggle with Super+N, edit inline, preview rendered markdown, save on exit.

otter-note creates sticky markdown notes that float above your desktop on a Wayland layer-shell surface. Pin notes to any corner, edit them in place, preview rendered markdown, and bind `Super+N` for quick access. Notes persist across sessions as plain markdown files. Edit them with any text editor outside Otter Shell.

## Commands

```bash theme={null}
otter-note add "ship release"     # append a quick note
otter-note new                    # open the note editor
otter-note --pin top-right new    # pin to a corner
otter-note list                   # list all notes
otter-note clear                  # delete all notes
otter-note --path /tmp/notes.md add test note  # use a custom file
```

## Editing Notes

In edit mode, the layer-shell surface edits your markdown file directly. Press **Ctrl+S** to save, or close the surface and it saves on exit. Press **Ctrl+M** to toggle rendered markdown preview.

In view mode, only the header buttons accept pointer and keyboard input. The note body is pass-through, so apps underneath keep receiving events and the note does not block your work.

| Shortcut | Action                  |
| -------- | ----------------------- |
| Ctrl+S   | Save note               |
| Ctrl+M   | Toggle markdown preview |

## Pinning

Use `--pin` to position the note surface in a corner before opening it:

```bash theme={null}
otter-note --pin top-right new
```

## Configuration

otter-note reads `~/.config/otter-shell/otter-note.conf`:

```conf theme={null}
notes_path = ""
```

* `notes_path`: absolute path for note storage. Empty uses `$XDG_DATA_HOME/otter-shell/notes.md`, falling back to `~/.local/share/otter-shell/notes.md` if `XDG_DATA_HOME` is unset

## Hotkey Setup

<Tip>
  Bind `otter-note new` to `Super+N` in your compositor config for sticky note access from anywhere on the desktop.
</Tip>