Skip to content
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.

Latest commit

 

History

History
36 lines (26 loc) · 1.57 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.57 KB
Raw

Deprecation Notice

NOTE: Due to how well the obsidian plugin latex suit works, I will be archiving this plugin as the usecase for me, namely writing latex, has faded away. The code is pretty modular and fairly clean, if this interests you, feel free to fork :)

obsidian-companion.nvim

This plugin integrates Neovim into your obsidian editing experience. Currently, it provides:

  • following you around as you open/focus files in obsidian

Note: As I am very busy ATM, progress will be erratic.

🖼️ See it in action

moving_around.mp4

🔧 Installing and Setup

  • Install the accompanying obsidian plugin (Instructions in the Readme)
  • Install this plugin using your favorite package manager: B4rc1/obsidian-companion.nvim
  • start a neovim instance with nvim --listen /tmp/nvimsocket or NVIM_LISTEN_ADRESS=/tmp/nvimsocket nvim (see :h --listen and :h $NVIM_LISTEN_ADRESS for more information)
    • in case you use neovim-remote this is done automatically (when using nvr executable).
    • the socket path is configurable in the obsidian settings
  • ???
  • Profit

🛣️ Roadmap

  • properly handle file renaming

💡 Ideas

  • more lua callback/autocmd

  • link following

  • cmp integration

  • syncronized scrolling

  • extract heading to ... neovim bind support

  • reverse sync

    • open file in neovim -> obsidian follows