No Description
Michał Góral 8551633ffe Added a confirmation of removing notes. 11 months ago
LICENSE Added a license. 1 year ago
README.md Use placeholders in templates. 1 year ago
config.ini.example {note} returns only a filename 1 year ago
rofi-notes Added a confirmation of removing notes. 11 months ago

README.md

rofi-notes

rofi-notes is a simple manager of text-based notes. For accessing and operating on notes, it utilizes rofi, a dmenu-like launcher.

Usage

To read and edit notes, simply run rofi-notes. You will be presented a list of notes. It will be empty if it’s your first run. To create a new note, simply type its name (a filename, with optional extension, like note.md). Your editor of choice will be opened with your soon-to-be-new-note. Remember to save it before quitting the editor!

Repeat this process to add more notes. If rofi wants to select existing note instead of creating a new one, press rofi.kb-accept-custom button (by default ctrl-return) to force it to use a typed file name instead of selected one.

Selecting any existing note will open it for a read-only display. In order to edit it, press alt-e.

You can configure an external command for opening some file types (like generating HTML page and opening it in a browser). To use it, press alt-c.

To remove selected notes, press alt-d. To rename a note press alt-m and type a new file name.

To grep contents of notes, press alt-g, and enter a search phrase.

For all of avbove operations you can also select multiple entries.

Templates

Notes can have templates on per-filetype basis. By default template files are stored in ~/notes/.templates/{file-extension}. For example, .templates/adoc will be used for all asciidoc files (i.e. the ones in form *.adoc), .templates/md for *.md files and so on.

Templates accept {note} and {env} placeholders.

Hooks

Hooks are commands which are automatically executed after a note was successfully edited, moved or deleted. There’s also additional after_success hook which is executed after command is successfully executed for all selected notes.

Configuration

Configuration file is stored e.g. inside ~/.config/rofi-notes/config.ini (Free Desktop’s XDG directories standard). See config.ini.example for example configuration.