2 releases
0.1.1 | Jul 16, 2024 |
---|---|
0.1.0 | Jul 10, 2024 |
#174 in Text editors
40 downloads per month
15KB
306 lines
Zapnote ⚡
Lightning-fast template-based note generator
About
Effective note-taking is essential for productivity and knowledge retention. For individuals with a terminal-based workflow, using a GUI application like obsidian can be cumbersome for creating template-based notes. Zapnote adresses this by providing a lightning-fast, template-based note generation system that fits right into your command-line workflow.
Instalation
The binary name for zapnote is zn
.
Cargo
You can install it using cargo
.
$ cargo install zapnote
Building
You can build yourself from source.
$ git clone https://github.com/LucasMartinsVieira/zapnote.git
$ cd zapnote
$ cargo build --release
$ ./target/release/zn --version # Copy the binary to your $PATH
Usage
Zapnote has two commands for note creation: note
(alias n
) for regular notes, and journal
(alias j
) for journaling (not yet available).
$ zn note some_template some_file
Configuration
To use zapnote, create a zapnote.toml
config file in $XDG_CONFIG_HOME/zapnote/
or $HOME/.config/zapnote
. Run zapnote once to auto-generate or manually create it with the contents of default-zapnote.toml.
$ zn n . .
# or
$ mkdir -p ~/.config/zapnote/ && touch ~/.config/zapnote/zapnote.toml
Dependencies
~3–14MB
~121K SLoC