A dead simple personal wiki plugin for Vim
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


*vimboy.txt*  For Vim version 7.0 or later.                           *vimboy*

Vimboy - a dead simple personal wiki plugin~

With Vimboy, you can create personal, local wikis. In buffers with the
'filetype' "vimboy", all file names that appear in the buffer link to the
respective files in the same directory. In autolink-mode, this happens as
soon as a filename appears in the text. Otherwise, surround the filenames
with [square brackets].

The name stems from GNOME's Tomboy, which has similar features.

CONFIGURATION                                           *vimboy-configuration*

It is convenient to declare your wiki directories in your vimrc like this: >
    au bufread,bufnewfile ~/path/to/wiki/* set ft=vimboy

Set the variable *g:vimboy_autolink* to 0 to disable autolink-mode. Default is 1.

Set the variable *g:vimboy_hl_deadlinks* to 1 to highlight dead links (links
to non-existing files). Works only if autolink-mode is off. Default is 0.

USAGE                                                           *vimboy-usage*

To start a wiki, create a new file in your wiki directory, like "Main Page".

To create a new page in autolink-mode, visually select one or more words and
press <CR>, or press <CR> on one word in Normal mode. In bracket-mode, just
create a dead link by surrounding the new page name with brackets, then follow
the newly-created link.

To follow a link, put the cursor on it and press <CR> in Normal mode, or
double-click it. The linked page will open in a new tab.

To delete a page, use <Leader>wd (by default: \wd - think of "wiki delete").

TIPS                                                             *vimboy-tips*

- Filename completion (|i_CTRL-X_CTRL-F|) is awesome for completing links!
- Use hard- or softlinks for page aliases.
- How you format your text is up to you! If you like to use Markdown, you can
  set the 'filetype' to "markdown.vimboy" to get syntax highlighting for both.
- Put your wiki directory under version control to get a history and make it
- Vimboy's sister project "RoboBoy" lets you sync your wiki with Android
  devices: https://github.com/blinry/roboboy