Skip to content

📄 zsh-notes — Write markdown formatted notes quickly

License

Notifications You must be signed in to change notification settings

dominiklohmann/zsh-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

📄 zsh-notes

Write markdown formatted notes quickly.

n name to write a new note, n to read or edit existing notes.

Requirements

  • Required: Set NOTES_DIRECTORY to an existing directory that you want to contain your notes.
  • Required: fzf for fuzzy file finding.
  • Optional: bat for better file previews.

Installation

Using a Plugin Manager

It is recommended that you use a plugin manager like Antibody to install this plugin. Your .zshrc might look like this with Antibody:

antibody bundle <<- EOF > "$(antibody home)/plugins.zsh"
	# Note taking plugin
	dominiklohmann/zsh-notes
EOF

source "$(antibody home)/plugins.zsh"

Manual Installation

Clone the directory and source source path/to/zsh-notes/notes.plugin.zsh in your .zshrc.

License

zsh-notes is licensed under an MIT license.

About

📄 zsh-notes — Write markdown formatted notes quickly

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages