dky / vim-logbook

🗄 A logbook in the comfort of your own vim

vim-logbook

vim-logbook is a minimalist vim plugin which makes keeping a programming logbook easier. I find that keeping a logbook improves my learning, debugging and focus.

I've blogged about keeping a logbook, and I highly recommend Peter Lyons' article on the same topic.

vim-logbook assumes the following structure:

• Each day's logs are stored in a separate file, stored at ~/logbook/yyyy-mm-dd.md
• Each logbook entry is marked with a timestamp

Commands

vim-logbook implements two commands:

• :Lb - open today's logbook in the current buffer
• :Ts - insert a timestamp under the cursor

Example log file

Tue 23 Jan 23:24:00 2018
- TODO:
- Write README for vim-logbook
- Write help doc for vim-logbook

Tue 23 Jan 23:27:57 2018
- Vim help doc guidelines can be found with `:help help-writing`
- http://stevelosh.com/blog/2011/09/writing-vim-plugins/#write-a-vim-help-document

Tue 23 Jan 23:38:55 2018
- Updated vim-logbook readme with logbook example

Install

vim-logbook can be installed with your favourite plugin manager.

• vim-plug:
  1. Add Plug 'jamesroutley/vim-logbook' to your .vimrc
  2. Run :PlugInstall