Skip to content

0xble/zellij-notepad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zellij-notepad

A Zellij plugin that spawns a floating notepad pane using your $EDITOR.

Features

  • Opens a timestamped markdown file in your $EDITOR
  • Floating pane pinned by default (stays visible when switching focus)
  • Toggle behavior (no duplicate panes)
  • Notes saved to ~/.config/zellij/notes/

Installation

From Release

curl -L https://github.com/0xble/zellij-notepad/releases/latest/download/notepad.wasm \
  -o ~/.config/zellij/plugins/notepad.wasm

From Source

git clone https://github.com/0xble/zellij-notepad
cd zellij-notepad
cargo build --release
cp target/wasm32-wasip1/release/notepad.wasm ~/.config/zellij/plugins/

Configuration

Add the plugin to load_plugins in your Zellij config:

load_plugins {
    "file:~/.config/zellij/plugins/notepad.wasm"
}

Keybinding

Add a keybinding in the shared_except "locked" block:

bind "Alt i" {
    MessagePlugin "notepad" {
        name "toggle"
    }
}

Editor

The plugin uses zellij's scrollback_editor setting, which defaults to $EDITOR.

To use a different editor specifically for zellij (including this plugin):

scrollback_editor "/path/to/your/editor"

Or set your $EDITOR environment variable globally.

Permissions

The plugin requests:

  • OpenFiles - open note file in editor
  • ChangeApplicationState - focus notepad pane
  • ReadApplicationState - track notepad pane lifecycle

Usage

  • Press Alt+i to open or focus the notepad
  • Close the notepad normally (e.g., :q in vim), then Alt+i spawns a fresh one

CLI

zellij pipe notepad "toggle"

Requirements

  • Zellij 0.43+
  • An $EDITOR set (vim, nvim, etc.)

License

MIT

About

Zellij plugin for a floating vimput notepad with toggle behavior

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors