Open-source project
jdhao/nvim-config avatar
jdhao/nvim-config

jdhao/nvim-config reads as a documented personal Neovim setup, not a distribution

A modern Neovim configuration with full battery for Python, Lua, golang, Markdown, LaTeX, and more...

4,398 stars608 forksLuaMIT

At a glance

What is it?
A heavily commented Lua Neovim configuration for Linux, macOS and Windows, written only for the newest Neovim build, where the author asks you to copy pieces rather than clone the repo. Useful as a reference; weaker as something to install whole.
Who is it for?
Adopt jdhao/nvim-config if you already run Neovim and want a well-commented set of mappings and plugin choices to read and borrow from. Do not adopt it if you want a supported distribution, because the author states the repo is maintained only for the latest stable Neovim build, with no effort spent on backward compatibility, and recommends against cloning it whole.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 7 days ago.
What is it written in?
Mainly Lua, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • jdhao/nvim-config4,398 ★ · +10
Star history
Repository2026-09-232026-11-15
jdhao/nvim-config4.4k4.4k

10 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

init.lua and ginit.vim split terminal and GUI startup

Two files decide how this configuration reaches Neovim, and the split matters more than anything else in the repo. The README names init.lua as the config entry point for terminal Nvim, and ginit.vim as the additional config file for the GUI client of Nvim. If you run Neovim inside a terminal multiplexer, ginit.vim never runs. If you launch the macOS or Windows GUI build, init.lua still loads and ginit.vim adds to it. That is a small design decision, but it means a single repo has to serve at least two different start paths, and any mapping or plugin you assume is present may have been placed in the half that your client does not read.

The rest of the tree follows the standard Neovim layout: lua/ for the bulk of the Lua code, plugin/ for scripts loaded at startup, after/ for changes applied once plugins have registered themselves, autoload/ for lazily resolved functions, ftdetect/ for filetype detection, my_snippets/ for Ultisnips definitions, and spell/ for spell files. The repository also carries tooling for the configuration itself, .stylua.toml for formatting, .pre-commit-config.yaml for hooks, and _typos.toml for spelling checks. This is a config that is linted and formatted like source code, not a loose collection of vimrc lines.

The config refuses to support older Neovim builds

The README states that this config is maintained only for the latest nvim stable build and that no effort is spent on backward compatibility. That single sentence sets the terms for everything else, and it should be read as a hard edge rather than a preference. Anyone whose distribution still packages an older Neovim should look at the tagged releases, such as v0.11.4 (config for nvim 0.11.4), rather than the default branch.

The default branch also moves faster than any single fixed point of it. The last push was on 2026-11-01, so what you clone today is not a state anyone froze against one editor version. The boundary here is the editor version, not the author's attention to the repository.

Lazy.nvim loads a battery aimed at Python, Lua, Go, Markdown and LaTeX

Plugin management goes through Lazy.nvim, and what sits behind that choice is a fixed set of roughly two dozen plugins rather than a general framework. Completion and snippets come from nvim-cmp and Ultisnips, language intelligence from nvim-lspconfig, highlighting from nvim-treesitter, and code folding comes from nvim-ufo and statuscol.nvim.

The pair most worth understanding is nvim-autopairs and vim-sandwich, which overlap on purpose: autopairs handles inserting matching pairs, sandwich handles adding, replacing and deleting them after the fact. The README's closing line of dots in the feature list signals that the count is open, so the practical set is larger than what the list shows. Search is where the config is most opinionated: fzf-lua takes over file finding, help grepping, project-wide grepping, buffer tagging and buffer switching, all in floating windows. hop.nvim handles short-distance cursor jumps, and asyncrun.vim runs code without blocking the editor. Editing goes past the terminal too, since firenvim runs real Nvim in the browser.

The repository sends you to docs/README.md instead of an install command

There is no install command in the README itself, and no package name, no bootstrap curl line, nothing to copy into a shell. The README points to doc here, docs/README.md, for how to install Nvim's dependencies, Nvim itself, and how to set up on different platforms for Linux, macOS, and Windows. So the install path is deliberately external to the file most readers open first, and anyone wanting the exact commands has to read the second document.

That matters for the decision you are making. Cloning is possible, and ginit.vim plus the standard directories mean the repo would load, but the README says plainly that while you can clone the whole repository and use it, it is not recommended. Good configurations are personal, and the author asks readers to copy the part they want into their own config file. The tutorial, then, has no commands at all: start Nvim, open docs/README.md for the platform steps, then copy individual Lua files out of lua/ into your own configuration and read the comments while you do it. The comments are the product here.

The leader key is a comma and the mappings are published as a table

The README publishes a shortcut table instead of leaving keybindings to be discovered, and it fixes the leader character first: in the listed shortcuts, <leader> represents ASCII character ,. Everything documented in that table therefore hangs off comma, and knowing that one fact makes the rest of the table usable immediately.

The pattern behind the f group is consistent. <leader>ff opens fuzzy file searching in a floating window, <leader>fh fuzzy help file grepping, <leader>fg fuzzy project-wide grepping, <leader>ft fuzzy buffer tag searching, and <leader>fb fuzzy buffer switching, each with platform given as Linux/macOS/Win. <leader>ev edits the Nvim config in a new tabpage and <leader>sv reloads it, so editing your own configuration never requires leaving the running editor. Housekeeping mappings follow: <leader><Space> removes trailing white spaces, <leader>y copies the content of the entire buffer to the default register, <leader>cd changes the current working directory to the directory of the current buffer, and <leader>gs shows Git status. Git work beyond that runs through vim-fugitive. Each row carries its mode and platform, which is unusual care in a config README and the reason these mappings can be trusted as documentation rather than as a suggestion.

Adopting it wholesale means inheriting somebody else's keymap

The clearest limitation is the one the author names: this is a personal config, and the whole-repo install path is explicitly discouraged. The reason shows in the layout. A reader who disagrees with the comma leader, or who already uses vim-sandwich, or who works in a language not in the plugin list, has to read and delete Lua before the editor becomes usable.

The plugin surface is the second limit. The config carries roughly two dozen plugins, including nvim-treesitter, and nvim-cmp talking to language servers that nvim-lspconfig configures. What is documented is narrower: nvim-cmp, nvim-lspconfig, fzf-lua and the folding pair are present, and the plugin list is open ended. A reader who wants a smaller editor has to do the pruning work themselves, and the config gives no guidance on which parts are load bearing.

A third boundary is external tooling. firenvim needs a browser, render-markdown.nvim and vimtex need their own toolchains for preview, and vimtex in particular drives LaTeX compilation.

Where this differs from a distribution such as LazyVim

A distribution and a personal config differ in what they promise. LazyVim is built around the idea of a curated plugin specification that other layers build on, so a user composes their setup from documented specs and can override an individual plugin without reading the distribution's internals. jdhao/nvim-config has no such layer. It is one author's finished opinion, heavily commented so the reasoning is visible, with no interface between the user and the plugin choices.

That difference shows most clearly in how each one handles change over time. A distribution updates its plugin set as a unit, so the editor behaves the same way on every machine that installs it. This repo hands you whatever combination the author settled on, tuned for one specific editor build. For reading and lifting code, the comments are the advantage and they outweigh the packaging gap. For installing and forgetting, the gap is decisive.

Editorial conclusion

Adopt jdhao/nvim-config if you already run Neovim and want a well-commented set of mappings and plugin choices to read and borrow from. Do not adopt it if you want a supported distribution, because the author states the repo is maintained only for the latest stable Neovim build, with no effort spent on backward compatibility, and recommends against cloning it whole. Before copying anything, check the Neovim version your own machine runs, because the config is written for the latest stable build and the release tags such as v0.11.4 (config for nvim 0.11.4) are the way to match an older one.

Frequently asked questions

How do I install jdhao/nvim-config?

The README contains no install command and points instead to docs/README.md, which covers installing Nvim's dependencies, Nvim itself, and setup on Linux, macOS, and Windows. It also states that cloning the whole repository and using it is not recommended, and encourages copying the parts you want into your own config file.

Which Neovim version does jdhao/nvim-config support?

It targets only the latest nvim stable build, and no effort is spent on backward compatibility, so older editor builds are unsupported.

Which plugin manager does jdhao/nvim-config use?

Plugin management goes through Lazy.nvim, with completion via nvim-cmp, LSP support via nvim-lspconfig, fuzzy searching via fzf-lua, and folding through nvim-ufo and statuscol.nvim.

What does init.lua do versus ginit.vim in jdhao/nvim-config?

init.lua is the config entry point for terminal Nvim, while ginit.vim is the additional config file for the GUI client of Nvim. The two serve different start paths on Linux, macOS, and Windows.

What is the leader key in jdhao/nvim-config?

In the README's shortcut table, <leader> represents the ASCII character ,. Mappings such as <leader>ff for fuzzy file searching and <leader>sv for reloading the config hang off it, each listed with its mode and platform.

Official sources

  1. Issues
  2. jdhao/nvim-config on GitHub
  3. License: MIT
  4. README
  5. Releases
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/jdhao-nvim-config.svg)](https://hysenlabs.com/projects/jdhao-nvim-config)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/jdhao-nvim-config.svg)](https://hysenlabs.com/projects/jdhao-nvim-config)

Was this useful?