Skip to content

A networked note management plugin for Vim

Notifications You must be signed in to change notification settings

seagoj/vim-roam

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

Vim-roam is a plugin for networked note management in Vim. The name "vim-roam" takes from the popular note taking tool Roam research, and our goal is to implement core features present in Roam (along with other growing note tools like Obsidian.md, Notion, etc) in a vanilla Vim environment.

Dependencies

This plugin builds on the fantastic wiki.vim plugin, which implements a lightweight core for managing a personal wiki in Vim. A separate wiki.vim development fork is maintained for managing low-level changes needed for vim-roam functionality. This is purposefully separated from the main vim-roam repo to clearly distinguish the extended features and configuration that fall outside the scope of the original wiki.vim project.

What does it do

vim-roam makes it easy to maintain a personal wiki on a set of local Markdown files. Most of this is enabled by the core wiki.vim functionality (see their documentation for more), but vim-roam extends this by improving the underlying note graph system and backlink exploration.

More broadly, the vim-roam initiative encompasses a set of ideals and compatible external tools that create a better overall wiki experience. These include the direct vim-roam extensions vim-roam-task (for task management) and vim-roam-md (for syntax highlighting), as well as more general tools like fzf.vim, ultisnips, tabular, and bullets.vim

Comparison with Vimwiki

Compared to vim-roam and wiki.vim, vimwiki is a slightly bulkier plugin with a larger feature scope that may introduce conflicts or hinder customization. vim-roam and wiki.vim are likely more suitable for those interested in greater low-level control over their Vim environment and wish to use external Markdown filetype plugins without conflicts. That said, you should absolutely give vimwiki a look if you haven't already; it does a lot of things well, has an active community, and could satisfy all of your needs.

About

A networked note management plugin for Vim

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vim Script 68.7%
  • Python 31.3%