Skip to content

2KAbhishek/nvim2k

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
November 22, 2023 05:41
lua
December 4, 2023 07:45
July 13, 2022 09:12
November 22, 2023 06:58
November 26, 2023 12:18

nvim2k

License People Stars Forks Watches Last Updated

Your Personalized Development Environment β€οΈπŸ‘¨β€πŸ’»

nvim2k Demo
nvim2k screenshot

Handcrafted neovim configs for the ultimate CLI dev experience, completely in lua

Here's a (slightly dated) video walkthrough

✨ Features

  • Fully configured LSP: Out of the box LSP and completions, including Copilot (optional)
  • Awesome keybindings: Intuitive and well documented keybindings with which-key
  • Blazingly fast: Starts up in less than 50ms thanks to extensive lazy loading
  • Batteries included: Has all the necessary plugins included out of the box
  • Git in there: Powerful git integrations thanks to lazygit, fugitive, gitsigns and more
  • Pretty colors: Comes with treesitter and onedark preconfigured with full transparency support
  • Goto for notes: Comes with powerful note-taking capabilities, thanks to telekasten
  • Tmux integration: Just works, with your tmux configurations out of the box
  • Dev tools: Comes with debugging, testing, database and REPL support, pick and choose
  • and many more!

But most importantly::

Easy extensibility: nvim2k has a simple and scalable config structure that promotes personalization, so go ahead, bring your keybindings, configs and plugins over, and truly make nvim2k: Your Personalized Development Environment!

⚑ Setup

βš™οΈ Requirements

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of neovim

  • Python provider is necessary for some operations: pip install neovim

  • Some command line tools: fd, ripgrep

  • To use nvim2k for notes, make sure to add export NOTES_DIR=your/notes/path as a env var video with more info

πŸ’» Installation

To install nvim2k simply clone the repo and setup symlinks

git clone https://github.com/2kabhishek/nvim2k

On Linux and Mac

ln -sfnv $PWD/nvim2k $HOME/.config/nvim

On Windows Powershell

New-Item -ItemType SymbolicLink -Path "$env:LOCALAPPDATA\nvim" -Target "$PWD\nvim2k" -Force

πŸš€ Usage

Edit files in lua/core for tweaking options, and to add/remove functions and autocmds

πŸ“¦ Plugins

To add new plugins simply add it to the plugins list

For plugin configs you can place them in these folders based on the functionality:

  • lang: Plugins related to language features, completions, lsp, debugging etc.
  • tools: General purpose tool plugins that aid in the editing experience.
  • ui: Cosmetic plugins, things that make neovim pretty.

⌨️ Keybindings

If you want to change functionality of a core keybinding, edit core/keymaps

To add new keybindings visit the which-key config

πŸ§‘β€πŸ’» Behind The Code

🌈 Inspiration

I have been using vim/neovim for 6+ years now, wanted to create a fun and easily extensible neovim config for everyone to use

πŸ’‘ Challenges/Learnings

  • Finding out just the right plugins and configs!
  • Setting up the initial config structure with lazy loading was tough.

🧰 Tools Used

  • dots2k β€” Dev Environment
  • nvim2k β€” Personalized Editor
  • sway2k β€” Desktop Environment
  • qute2k β€” Personalized Browser

πŸ” More Info

  • nerdy.nvim β€” search nerdfont glyphs from inside neovim
  • co-author.nvim β€” easily add co authors to your git commits

⭐ hit the star button if you found this useful ⭐

Source | Blog | Twitter | LinkedIn | More Links | Other Projects

About

Your Personalized Development Environment β€οΈπŸ‘¨β€πŸ’»

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Languages