Note

• Features
• Installation
• Usage
• Roadmap

---

Simple notes storage mechanism

Features

• Simple synchronization via git
• FZF Integration
• Friendly zsh and bash completions
• Saving all notes changes with git
• It respects widely used environment variables such as VISUAL and PAGER

Note

It is highly recommended to use the neovim as editor and peek.nvim plugin as markdown previewer

Installation

Dependencies

Dependencies:

• git

Optional dependencies:

• bat - For render notes in terminal
• tree - Show tree of notes
• fzf - Beauty notes search
• rg - Search notes by content

Install from source:

git clone https://github.com/thek4n/note.git
cd note
make install

Install from AUR (recommended):

yay -S note-manager

Run tests

make test

Usage

export PAGER=less
export VISUAL=nvim
note init -p ~/.notes -r ssh://remote/home/user/.notes-storage
note edit someNote.md
note show someNote.md
note git push

---

note sync  # to automaticly pull and merge remote changes

Note

You can also check out man note for documentation.

Other markdown previewers

Grip

NOTEPAGER="grip -b" note show someNote.md

Glow

NOTEPAGER="glow" note show someNote.md

Roadmap

• Graph building based on markdown links
• Rewrite on posix shell
• Lock-file
• Synchronization
• Search by notes
• Directories
• Tree of notes

▲