For me, keeping a simple journal, provides a easy way of reflecting on the day. Done right, keeping a diary has been linked to creativity, and reflective learning. Moreover, recording one good thing per day has both mental health, and positive habit forming benefits.
Core to my ability to maintain the habit of keeping a journal is making it as easy as possible to add / maintain entries. My journal is a brief affair that balancesthe main benefits of capturing and reflecting on the day’s events with the effort required to do so.
Given this focus on simplicity, why would I consider Vim? Surely I’d be stuck in a single entry forever whilst I try to exit?
In fact Vim is perfect for the task of journaling; it is readily, freely available on my phone via termux, my laptop, or at a push via ssh. Whilst the same may be said about other editors, Vim’s super power as far as journalling is that it can apply templates contextually. Tying these templates together with Vim’s ability to process shell commands, makes it is possible to create a personalised entry with effectively zero effort. Using a editor in a terminal means I don’t have the visual cruft of a bespoke app with the associated cognitive load and interaction cost. Finally, rolling my own journal process, allwos me to fully own my data. I’m not tied to a proprietary platform, and don’t have to worry about about how the data is used.
The solution I have come to is based on three apps:
- Vim: to create and populate journal entries
- rclone to save entries to a cloud provider
- Bash to handle file creation, and invoking vim/rclone
The first step would be to create a template. For the journal, this is essentially a journal entry without the detail. The template may be placed anywhere, but it makes sense to keep it in your
.vim directory. mine is stored in
~/.vim/templates/journal.skeleton. Wherever you store yours, it needs sourcing in your local functions.
## What happened ## What went well ## What didn't go well
Next, we need to create a function to invoke the template. My function is designed to only trigger if I create a new file in a specific directory, or any of its subdirectories.
This function is saved in
~/.vim/local_functions. Again, you can save yours elsewhere, but you’ll need to make sure your
.vimrc is sourcing the correct path
augroup journal autocmd! " populate journal template autocmd VimEnter */journal/** 0r ~/.vim/templates/journal.skeleton " set header for the particular journal autocmd VimEnter */journal/** :call JournalMode() " https://stackoverflow.com/questions/12094708/include-a-directory-recursively-for-vim-autocompletion autocmd VimEnter */journal/** set complete=k~/documents/journal/**/* augroup end
we’ll source this function in our
So far so good. If I create a file under any sub/directory of
~/documents/journal, vim should paste the template as it opens. To make the journal entries a bit more specific why not add the date? There’s a few ways to achieve this, but in the spirit of keeping things simple, why not take the filename, and process that? Let’s create the function, again under
" set header title for journal & enter writing mode function! JournalMode() execute 'normal gg' " filename in format dd-mm-yy.md " add a line to file in format ## dd-mm-yy let filename = '##' . ' ' . expand('%:r') call setline(1, filename) execute 'normal o' endfunction
Now all we need is a script that will:
- create the file
- open it in vim
- save it to our cloud storage
#!/bin/sh # A Script to create a journal entry, open it in vim, and save it JOURNAL_DIR='~/documents/journal/' # each year gets a dir, each month a subdir ENTRY_DIR=$(date +%Y/%B) mkdir -p $JOURNAL_DIR$ENTRY_DIR cd $JOURNAL_DIR$ENTRY_DIR vim $(date +%d-%m-%y).md # my rclone is pointing to an instance of OwnCloud rclone copy ~/documents/journal owncloud:journal
as I’ve been using this, I’ve found myself repeating simple prases. To reduce this repetition, I’ve added the following abbreviations to my
abbr _ok OK day, abbr _gd Good day, abbr _pd Poor day,
The journal process I have at the moment is a near perfect for my needs, it is low enough to not get in the way of keeping the journal itself, meaning I get the benefit without extraneous effort.
Whilst it’s ideal at the moment, there are a few things that could further enhance the process, namely:
- using a yaml block to capture richer data
- encryption of journal entries
- data analysis / sentiment analysis of journal entries
For the time being though, it’s good enough to be bulding the habit and reflecting on each day.