Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Easy note taking in Vim
VimL Python HTML

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
notes
INSTALL
README.md
TODO.md
autoload.vim
filetype.vim
notes.vim
scanner.py
syntax.vim

README.md

Easy note taking in Vim

The notes.vim plug-in for the Vim text editor makes it easy to manage your notes in Vim:

  • Starting a new note: Execute the :NewNote command to create a new buffer and load the appropriate file type and syntax
  • Saving notes: Just use Vim's :write and :update commands, you don't need to provide a filename because it will already have been set based on the title (first line) of your note (you also don't need to worry about special characters, they'll be escaped)
  • Deleting notes: The :DeleteNote command enables you to delete the current or given note
  • Searching notes: :SearchNotes keyword … searches for keywords and :SearchNotes /pattern/ searches for regular expressions
    • Back-references: The :RelatedNotes command find all notes referencing the current file
    • A Python script is included that accelerates keyword searches using an SQLite database
  • Navigating between notes: The included file type plug-in redefines gf to jump between notes and the syntax script highlights note names as hyper links
  • Writing aids: The included file type plug-in contains mappings for automatic curly quotes, arrows and list bullets
  • Embedded file types: The included syntax script supports embedded highlighting using blocks marked with {{{type … }}} which allows you to embed highlighted code and configuration snippets in your notes

Here's a screen shot of the syntax mode using the slate color scheme:

Syntax mode screen shot

Install & usage

Unzip the most recent ZIP archive file inside your Vim profile directory (usually this is ~/.vim on UNIX and %USERPROFILE%\vimfiles on Windows), restart Vim and execute the command :helptags ~/.vim/doc (use :helptags ~\vimfiles\doc instead on Windows). To get started execute :NewNote or :edit note:.

Contact

If you have questions, bug reports, suggestions, etc. the author can be contacted at peter@peterodding.com. The latest version is available at http://peterodding.com/code/vim/notes/ and http://github.com/xolox/vim-notes. If you like the script please vote for it on Vim Online.

License

This software is licensed under the MIT license.
© 2010 Peter Odding <peter@peterodding.com>.

Something went wrong with that request. Please try again.