vim-geeknote

Geeknote Plugin for Vim. Under active development.

Supported Features

Integrates Geeknote/Evernote into Vim.

• Notebook navigation, creation, and renaming
• Note viewing, renaming, editing, and creation.

Screenshots

Dependencies/Requirements

• Vim 7.4.364 or newer (issues observed with earlier versions)
• Linux (not tested on operating systems)

Installation

1. If you have not done so already, install Geeknote and login to make sure it is functional. You must login before attempting to use the plugin.

2. Use your plugin manager of choice to install plugin.

• Vundle
  • Add Bundle 'https://github.com/neilagabriel/vim-geeknote' to .vimrc
  • Run :BundeInstall
• Pathogen
  • git clone https://github.com/neilagabriel/vim-geeknote ~/.vim/bundle/vim-geeknote

Optional Setup

Quick toggle:

noremap <F8> :Geeknote<cr>

Note format:

Use the option g:GeeknoteFormat to set the format mode used when saving notes to Geeknote. This is the equivalent of the --format options that Geeknote supports. E.g.:

let g:GeeknoteFormat="markdown"

Warning: It is not advised that you use this option, use it at your own risk. The issue is that in the process of converting your notes from markdown to HTML and back, content is often reformatted. Worse is that if you edit and save a note that has been reformatted, there is even a large potential to lose content! This is a side-effect of the various tools/libs that Geeknote uses in performing the conversions. With the default settings, notes saved with vim-geeknote bypass these format conversions. This means that notes will be saved exactly as they appear within Vim. It also means that the notes will appear in plain-text when viewed outside of Vim in Evernote. If you plan on creating, editing, and viewing your notes in Vim, this trade-off is well worth it. And of course it does not mean that you cannot use the markdown format in your notes.

Navigation Window Behavior:

Limit Width:

By default, vim-geeknote will attempt to resize the navigation window based on its current content. If you have notebooks or notes with very long names you may want to use the following option to cap the size of the window:

let g:GeeknoteMaxExplorerWidth=<value>

Where <value> is replaced with the max width of the window.

Fix Width:

Use the following option to fix the width of the window to a specific value:

let g:GeeknoteExplorerWidth=<value>

Where <value> is replaced with the desired width of the window. This option overrides all other width-related options.

Usage

Use :Geeknote to open/toggle the geeknote navigation window. If the navigation window is not visible, this command will split the current window vertically and display the navigation window on the left-side. If visible, the navigation window will be hidden. Notebooks can be expanded to show the notes they contain. To expand a notebook, simply navigate to the name of the notebook and hit <Enter>. Hit <Enter> again to close the notebook. To open/view a note, navigate to the note and hit <Enter>. The note will be displayed in the previous window if it is possible to do so or in a new vertical split. To save changes to the note, simply save the buffer (e.g. :w). The title of the note will be shown on the first line. The title line should not be deleted from the buffer but may be modified to rename the note.

Use :GeeknoteCreateNotebook <name> to create a new notebook.

To rename notebooks or notes, simply modify the the name of the notebook/note in the navigation window and save the bugger (e.g. :w). Any number of changes can be made before saving, but be sure not to modify an item's GUID.

Use :GeeknoteCreateNote <name> to create a new note. The note will be created in the notebook currently selected in the navigation window. If a notebook is not selected, the note will be created in the default notebook. A new buffer for the note will be displayed in the previous window if it is possible to do so or in a new vertical split.

Use :GeeknoteSaveAsNote to create a new note using the content of the current buffer. The first line in the buffer will be used as the note's title. The remainder of the buffer will be saved as note content. Note this this command will create and switch to a new buffer.

To move a note into a different notebook, simply move the note's text (includes title and GUID) under the desired notebook in the navigation window and save the buffer. Similar to renaming, any number notes can be moved before saving the buffer.

Use :GeeknoteSync to update the navigation with the latest data on the Evernote server. Warning, any notes that are opened when this command is issued will not be updated. Support for this will be added in future releases.

Acknowledgments

• Geeknote
• The Nerd Tree
• Vim Plugin Starter Kit

Todo

• Refresh open notes upon :GeeknoteSync
• Tag support
• Prettier navigation window
• Improved notebook creation process

License

Copyright (c) Neil Gabriel. Distributed under the same terms as Vim itself. See :help license.