
Journal
Vimwiki + Neovim Setup on Mac
These instructions are specific to Mac & Linux with Homebrew but the concept works on any Unix system with minor tweaks.
Setup
1. Install Neovim
brew update
brew install neovim
You can now launch Neovim with the nvim command.
2. Install vim-plug
The cleanest way to manage plugins. Widely supported, no ceremony.
sh -c 'curl -fLo "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/autoload/plug.vim --create-dirs \
https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
3. Create your Neovim config
Create the config file:
mkdir -p ~/.config/nvim/
nvim ~/.config/nvim/init.vim
Paste in the following. This enables spellcheck, installs vim-plug, installs the sonokai colour scheme, and configures Vimwiki to use Markdown stored at ~/Documents/Notes.
autocmd BufRead,BufNewFile *.txt,*.md setlocal spell spelllang=en_us
set nocompatible
filetype plugin on
syntax on
call plug#begin()
Plug 'vimwiki/vimwiki'
Plug 'sainnhe/sonokai'
call plug#end()
let g:vimwiki_list = [{'path': '~/Documents/Notes',
\ 'syntax': 'markdown', 'ext': '.md'}]
let g:sonokai_style = 'maia'
let g:sonokai_better_performance = 1
colorscheme sonokai
4. Install the plugins
From inside Neovim, run:
:PlugInstall
This opens a split and installs everything declared in your config. Done.
Reference
Key bindings
| Command | What it does |
|---|---|
\ww | Open your wiki index (~/Documents/Notes/index.md) |
ctrl+space | Toggle a checkbox (- [ ] → - [X]) |
enter (over text) | Turn text into a hyperlink, or follow an existing one |
enter (on new link) | Create a new wiki page for that link |
backspace | Go back to the previous wiki page |
:h vimwiki-syntax | Syntax reference (remember: we're in Markdown mode) |
:h vimwiki-mappings | Full keybinding reference |