whatisgithub

What is netherite.nvim?

luismede/netherite.nvim — explained in plain English

Analysis updated 2026-05-18

15LuaAudience · developerComplexity · 2/5LicenseSetup · easy

In one sentence

A Neovim plugin for jotting down quick notes as plain Markdown files that stay in sync with your Obsidian vault or any Markdown-based editor.

Mindmap

mindmap
  root((netherite.nvim))
    What it does
      Quick notes in Neovim
      Syncs with Obsidian
      Plain Markdown files
    Tech stack
      Lua
      Neovim
      Markdown
    Commands
      Netherite toggle
      NetheriteMode
      NetheriteVault
      NetheriteHistory
    Use cases
      Fast note capture
      Obsidian vault sync
      Recent notes browsing
    Audience
      Neovim users

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Jot quick notes inside Neovim that automatically sync with an Obsidian vault.

USE CASE 2

Open a floating or split note window without leaving your Neovim workflow.

USE CASE 3

Browse and reopen recently used notes through a quick selection menu.

USE CASE 4

Bind a keymap to toggle a scratch note for fast capture while coding.

What is it built with?

LuaNeovimMarkdown

How does it compare?

luismede/netherite.nvimfruityman577/gmod-tinysvgiogamaster/tuxedo.nvim
Stars151515
LanguageLuaLuaLua
Setup difficultyeasyeasymoderate
Complexity2/51/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires Neovim 0.9.0 or newer and a plugin manager like lazy.nvim or packer.nvim.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

So what is it?

netherite.nvim is a plugin for Neovim, a text editor popular with programmers, that lets you write quick notes without leaving the editor. Those notes are saved as plain Markdown files in a folder you choose, so the same notes can also be opened and synced in Obsidian, a separate note-taking app, or really any editor that reads Markdown files. To use it, you need Neovim version 0.9.0 or newer and a folder to act as your notes vault, which defaults to a data folder Neovim already manages if you do not set your own. Installation is done through a Neovim plugin manager such as lazy.nvim or packer.nvim, or by manually copying the plugin's files into your Neovim configuration folder. Once installed, you configure it by calling a setup function with optional settings: where your vault lives, whether new notes open in a floating window in the center of the screen or a split window on the side, and how new note filenames are generated, including a base name plus date and time stamps. The plugin adds a handful of commands. One opens or closes the note window for a given filename, automatically adding the .md extension. Another changes the window style at runtime. A third lets you change which vault folder is active without restarting Neovim. A fourth lets you browse and reopen recently used notes through a selection menu. There is also a small Lua API for setup and toggling notes from your own configuration or keymaps. The README recommends pairing it with a separate plugin called render-markdown.nvim, which makes headings, lists, code blocks, and tables in your notes easier to read directly inside Neovim. The project is released under the MIT license.

Copy-paste prompts

Prompt 1
Help me install netherite.nvim using lazy.nvim and point it at my Obsidian vault path.
Prompt 2
Write a Neovim keymap that toggles a netherite.nvim scratch note.
Prompt 3
Explain the difference between netherite.nvim's float and split open modes.
Prompt 4
How do I configure netherite.nvim's filename_config to use custom date and time formats?

Frequently asked questions

What is netherite.nvim?

A Neovim plugin for jotting down quick notes as plain Markdown files that stay in sync with your Obsidian vault or any Markdown-based editor.

What language is netherite.nvim written in?

Mainly Lua. The stack also includes Lua, Neovim, Markdown.

What license does netherite.nvim use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is netherite.nvim to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is netherite.nvim for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.