Skip to content

DomanskiFilip/quick_notepad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

121 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quick Notepad

A modern, dual-mode text editor written in Rust that runs both in the terminal (TUI) and as a native GUI application. Built from scratch as part of the "build your own X" philosophy to create a fast, reliable, and customizable editor that does exactly what you need.

Rust

website

Features

Core Functionality

  • Dual Mode: Run in terminal (TUI) or as native GUI

  • Full Unicode Support: Proper handling of graphemes, emojis, and multi-byte characters

  • Syntax Highlighting: 25+ languages with custom theme support

  • Multi-Tab Interface: Up to 10 tabs with session persistence

  • Search & Navigation: Fast text search with match highlighting

  • Undo/Redo: Full edit history with intelligent grouping

  • Mouse Support: Click, drag, double-click, triple-click selection

  • Wayland Clipboard Integration: Works seamlessly with system clipboard

  • Configurable Shortcuts: All shortcuts in one place (for now you need to change in: src/core/shortcuts.rs)

Technical Highlights

  • Fast Rendering: Optimized for minimal redraws

  • Clean Architecture: Modular design across 25+ files and 6 packages

  • Zero Heavy Dependencies: Built with minimal external crates

  • size about 8MB, compared to "micro" 12MB<

Commands

Command Description
quick Open empty editor in terminal
quick <file> Open file in terminal
quick --gui Open empty editor in GUI
quick --gui <file> Open file in GUI
quick <file> --gui Open file in GUI (alternative)
quick --shortcuts Show all keyboard shortcuts

Installation (LINUX)

step by step:

download the app:

wget https://github.com/DomanskiFilip/quick_notepad/releases/latest/download/quick

make it executable:

chmod +x quick

run it first time for it to automatically install:

./quick

one liner:

curl -L https://github.com/DomanskiFilip/quick_notepad/releases/latest/download/quick -o quick && chmod +x quick && ./quick

if the app doesnt show up try reloading your shell:

# For Bash/Zsh:
source ~/.bashrc
# For Fish:
exec fish

Uninstall

rm ~/.local/bin/quick

Build from Source

git clone https://github.com/DomanskiFilip/quick_notepad
cd quick-notepad
./build-dist.sh
cd quick-notepad-[VERSION]-linux-x86_64
./install.sh

as you can see source has my build script: ./build-dist.sh which creates these scripts: ./install.sh and ./uninstall.sh in quick-notepad-[VERSION]-linux-x86_64

image icon generated using nano banana

About

my rust text editor (tui and gui)

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors