Neovim Config in Lua

A modular Neovim configuration written in Lua. This repository is both a fully functional editor config and a learning resource.

Documentation

readme/
├── README.md              — Overview (this page)
├── guide.md               — Learning guide for newcomers
├── reference.md           — Technical deep-dive
├── keymaps.md             — Complete key bindings reference
├── contributing.md        — How to make and test changes
└── keymap.markmap.md      — Keymap mindmap

Plugin Documentation

lua/plugins/readme/
├── README.md              — Plugin overview
├── guide.md               — Plugin guide for learners
├── reference.md           — Plugin technical reference
└── PLUGINS.md             — Quick-reference table of all plugins

Config Documentation

lua/config/readme/
├── README.md              — Config files overview
├── guide.md               — Config learning guide
└── reference.md           — Config technical reference

Full Neovim Guide

A comprehensive 14-chapter guide covering everything from first steps to contributing to Neovim core is available at nvim-docs/.

nvim-docs/
├── 01-getting-started/    — Installation, first steps, startup flow
├── 02-lua-programming/    — Lua from scratch through advanced FFI
├── 03-configuration/      — Every config file, options, autocmds
├── 04-keymaps/            — Modes, leader keys, remapping
├── 05-plugins/            — Lazy.nvim, LSP, Treesitter, Telescope
├── 06-languages/          — Language-specific tooling
├── 07-workflows/          — Daily development patterns
├── 10-advanced/           — Custom plugins, queries, performance
├── 11-troubleshooting/    — Systematic debugging
└── 13-quick-reference/    — Command and motion cheat sheets

Quick Links

Link	Description
readme/guide.md	Start here if you're new to Neovim
readme/keymaps.md	Every key binding at a glance
readme/reference.md	Architecture and configuration deep-dive
lua/plugins/readme/README.md	All plugins explained
lua/plugins/readme/guide.md	Plugin learning guide
lua/plugins/readme/PLUGINS.md	Plugin table overview
lua/config/readme/README.md	Config files explained
lua/config/readme/guide.md	Config learning guide
lua/config/readme/reference.md	Config technical reference
nvim-docs/README.md	Full Neovim learning guide
init.lua	Entry point