Go Back

My Note Taking Setup

Posted on September 6, 2022

Overview of my setup

I use neovim to write all of my notes in markdown and then use Obsidian to view and search my notes.

  1. Neovim (with some plugins)
  2. zk
  3. Obsidian

What is Zettlekasten?

Simply put, Zettlekasten is a way of organizing your notes by creating a interconnected web/graph using metadata like tags and subject headings. Being able to group your notes based on metadata creates a powerful way of relating other ideas and thoughts together.

Why use Markdown?

I use markdown because it makes writing professional and organized documents easy. Due to markdown and its simplistic nature it reduces your cognitive load when it comes to formatting and aesthetics. Markdown can also be converted to other formats including PDF and HTML. You might want to look at Pandoc for that.

Neovim Markdown Plugins

Neovim has many plugins you can install makes writing markdown documents easy. Below will be a list of the plugins I use and brief explanation of what they do.

  • "jakewvincent/mkdnflow.nvim" allows you to follow links in markdown files by pressing <Enter> to follow and <Delete> to go back.
  • "preservim/vim-markdown" gives better syntax highlighting, supports folds, and is able to conceal text.
  • "dhruvasagar/vim-table-mode" makes it extremely easy to create and align tables in markdown.
  • "mzlogin/vim-markdown-toc" gives you easy to use functions to generate the table of contents.
  • "dkarter/bullets.vim" makes it easier to write ordered, unordered, and todo lists.
  • "AckslD/nvim-FeMaco.lua" is a plugin used to make it easier to write code blocks in markdown. This plugins creates a temporary file in a new buffer that supports things like LSPs, autocomplete, etc (if you have it set up correctly). Using vim's command mode you can even run the code block if you want.
  • "mickael-menu/zk-nvim" this last plugin I use was made to be able to interact with "zk" through neovim.

Micheal Menu's ZK

Zk is a program that allows you to create Zettlekasten based notes in the terminal. This program has an easy to set up configuration file in TOML and supports things like tags, searching, templates, and much more. You are able to use other programs like fzf and bat to make it easier to look through your notes. The creator of zk also built a neovim plugin called zk-nvim that allows you to interface with zk through neovim.

Obsidian

Obsidian is a free markdown editor that uses Zettlekasten as a framework for managing and organizing your notes. Even though I do not need Obsidian for my note taking setup, I really like the UI, visualizations, and overall format of the markdown documents.

Summary

I write my markdown documents/notes in neovim and then visualize and study them using Obsidian. My workflow whether I am taking notes or writing code always involves the terminal. Being able to have a streamlined note taking set up with neovim, the terminal, and Obsidian makes it very simple to take quick and organized notes.