Introduction

This document is the personal knowledge base (KB) of Daniel Tompkins. More and more accounts of people (often programmers) using the KB structure to store frequently referenced information led me to begin building my own.

VimWiki

For this KB, I'm using VimWiki, a Personal Wiki for Vim, which provides a set of hotkeys in the Vim command-line text editor. This plugin allows you to instantly access your KB from anywhere in the terminal, and saves your notes in a .wiki file— or as common markdown with the following settings in your ~/.vimrc file:

let g:vimwiki_list = [{'path': '~/vimwiki/',
                      \ 'syntax': 'markdown', 'ext': '.md'}]

To search across the KB, you can use

:VWS <search pattern>

markdown-styles

For moving my .md KB to the Web, I'm using the generate-md function that's included with markdown-styles:

npm install -g markdown-styles

I use bash alias to quickly convert all .md files to .html. The "loosed-template" is a custom variation on the included jasonm23-dark theme:

alias markdown-html='generate-md --input ./ --output ./converted/ --layout loosed-template'

Mobile Editor

If you want to commit edits to your KB remotely, you can use the Spck Editor. It's a nice mobile code editor with built-in GitHub functionality for pulling from or pushing to a remote repo.

If you'd like to setup a similar KB structure, consider checking out the links that are provided on this page. Additionally, here's a wonderful markdown cheatsheet if you forget any syntax.