Note 📝

notenote is a gem for keeping a daily log of everything.

Install a Ruby gem:

gem install notenote

Initialize a folder for your daily notes:

note init %FOLDER_NAME%

⚠️ Note that although the name of the gem is notenote (note is already taken), the CLI command is note for simplicity.

I also highly encourage using aliases to save time typing. If you're using Zsh, I'd recommend going 1 letter:

alias n="note"
alias non="note on"
alias np="note push!"
alias na="note all"

Make sure to install the notenote extension for VS Code.

The extension will copy images or files from your notes to the notes folder.

note init command also generates a .notenote config file in your home folder:

{
  "notes_folder": "%FOLDER_NAME%",
  "date_format": "%d-%m-%Y",
  "editor_command": "code",
  "commit_message": "Added new notes"
}

note create today's note file

// 05-11-2022/today.md

note on creates a custom note file:

// It will create a new note file in today's folder:
// 05-11-2022/tax_return.md

Special characters break note on command. If you see an error like No matches found in the terminal, try using quotation marks for note's name:

note on 'How Are You Doing?'

Push new notes to Github with a default commit message from the .notenote config:

By default, note push will commit and push only if there were no changes or deletions in your notes.

note push! doesn't do any checks, it commits and pushes all your changes.

note pull simply does git pull --ff-only to safely pull new notes from Github.

Opens note folder in your editor.

Prints out the current notenote version.

All notes are created as Markdown files. I personally like the Kramdown version:

https://kramdown.gettalong.org/quickref.html

To test changes locally run:

Y | gem uninstall notenote && gem build note.gemspec && bundle && rake build && rake install

To release a new version run:

Y | gem uninstall notenote && gem build note.gemspec && bundle && rake build && rake release

This project is released under the MIT License.