README.md

Neovim Config

R.I.P. Kentaro Miura sensei 🥀

---

🎐 Intro

• ⚡BLAZINGLY FAST startup time in ~20ms, with over 100 plugins. (Tested on Micron Crucial MX500)
• Well structured in Lua.
• Easy to customize.
• Automized installation scripts, written in bash.
• Use lazy.nvim as plugin manager.
• Use delaytrain.nvim to train yourself into a better vimer, disable it if you want.
• Aligned icons across every plugin!

🧱 Structure

${HOME}/.config/nvim

├── after/
│   └── ftplugin/                  filetype-based rules
├── fonts/                         nerdfonts
├── ftdetect/                      filetype detection
├── scripts
│   ├── nvim_up.sh                 script for upgrade to neovim nightly
│   ├── setup_config.sh            script for installing dependencies for plugins
│   └── update_config.sh           script for fetch new commits of this repo
├── init.lua
├── lua/
│   ├── core/
│   │   ├── event.lua              event-based autocommands
│   │   ├── global.lua             global variables
│   │   ├── init.lua
│   │   ├── mapping.lua            basic keymaps
│   │   ├── options.lua            neovim options
│   │   └── pack.lua               custom packer wrapper
│   ├── keymap/                    plugin-related keymaps
│   ├── modules/                   plugin-configs
│   │   ├── completion/            nvim-cmp + LSP
│   │   │   ├── plugins.lua
│   │   │   └── server-settings/   settings for each LSP
│   │   ├── editor/
│   │   │   └── plugins.lua
│   │   ├── lang
│   │   │   └── plugins.lua
│   │   ├── tools/
│   │   │   ├── dap/               DAP settings for each language
│   │   │   └── plugins.lua
│   │   └── ui/
│   │       └── plugins.lua
│   └── utils                      utility functions
│       └── init.lua
├── snippets/
│   └── package.json               how `LuaSnip` reads snippets, vscode-style
├── spell/                         custom spelling correction
└── stylua.toml                    stylua settings

NOTE: You can rename/create folders inside modules, but ALWAYS remember to add a plugins.lua in it to register your plugins.

⚙️ Configuration & Usage

🎩 Suit up

Follow Wiki: Prerequisite and get yourself a cup of coffee ☕

🧑‍🍳 Cook it

Follow Wiki: Usage to spice it into your own flavor (WIP)

🛠️ Toolbox

Lists of Wiki: Installed Plugins (WIP)

🤔 FAQ

Refer to Wiki: FAQ (WIP)

⏱️ Startup Time

Tested with dstein64/vim-startuptime plugin.

Tested with rhysd/vim-startuptime, a CLI tool written in Go.

📸 Script Screenshots

🪨 Materials

Docs

• Lua docs
• neovim/options
• neovim/lua-api
• neovim Wiki
• Learn vim/neovim
  • alpha2phi/Neovim for Beginners, Neovim 101
  • Vim Tips Wiki
  • Vim Cheat Sheet
  • Learn Vimscript the Hard Way
  • Learn Vim the Simple Way, a web game to learn vim motions
  • vim-adventures, another web game to learn vim.
  • BooleanCube/NeovimKeys, offline vim motion game
  • ThePrimeagen/vim-be-good, a plugin by ThePrimeagen
  • ThePrimeagen/2-simple-steps, another vimtutor by ThePrimeagen
  • vimcdoc, a vim doc in Chinese, could be a plugin, a program or a webpage

YouTube channels

• ThePrimeagen/Vim As Your Editor, BLAZINGLY FAST alpha vimfluencer
• TJ DeVries, neovim core team

Awesomes

• neovimcraft
• LibHunt/neovim
• rockerBOO/awesome-neovim
• How I Vim
• nvim.sh, neovim plugin search from the terminal
• Neoland, a collection of plugins, themes and other resources for Neovim.

Trendy neovim news

• This Week In Neovim, aka TWiN, highly recommended, Archived
• This Week In Neovim, hosted by dotfly.com
• Reddit/neovim
• Twitter/neovim
• Neovim Official News, not so up-to-date

🎉 Acknowledgment

• ayamir/nvimdot
• glepnir/nvim
• ChristianChiarulli/nvim
• ray-x/nvim
• folke/dot/config/nvim
• jdhao/nvim-config