https://github.com/linuxuser255/nvim
My Neovim Config. Notable plugins & featues: Telescope, Harpoon,Tabnine, Lazy, VimBeGood, Bright-flash text yank to system clipboard, and much, much more.
https://github.com/linuxuser255/nvim
lazy-loading lazynvim lua lua-script neovim neovim-colorscheme neovim-config neovim-configuration neovim-dotfiles neovim-lua neovim-lua-plugin neovim-plugin vim
Last synced: 20 days ago
JSON representation
My Neovim Config. Notable plugins & featues: Telescope, Harpoon,Tabnine, Lazy, VimBeGood, Bright-flash text yank to system clipboard, and much, much more.
- Host: GitHub
- URL: https://github.com/linuxuser255/nvim
- Owner: LinuxUser255
- License: gpl-3.0
- Created: 2024-07-10T16:14:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-19T17:09:59.000Z (about 1 year ago)
- Last Synced: 2025-01-31T21:51:33.185Z (about 1 year ago)
- Topics: lazy-loading, lazynvim, lua, lua-script, neovim, neovim-colorscheme, neovim-config, neovim-configuration, neovim-dotfiles, neovim-lua, neovim-lua-plugin, neovim-plugin, vim
- Language: Lua
- Homepage:
- Size: 102 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Neovim Config
## Table of Contents
- [About this config](#about-this-config)
- [Supported Languages](#supported-languages)
- [Pre-install Requirements](#pre-install-requirements)
- [Installation](#installation)
- [Post Install](#post-install)
- [Netrw - Getting Started](#netrw---getting-started)
- [Remaps & Shortcuts](#remaps--shortcuts)
- [Moving lines Up & Down](#moving-lines-up--down)
- [Highlight Replace](#highlight-replace)
- [Presentations in Neovim](#presentations-in-neovim)
- [Netrw Cheat Sheet](#netrw-cheat-sheet)
- [Detailed Config and Tabnine Integration](docs/usage.md)
- [Tabnine Integration Separate Documentation](docs/Tabnine-Integration.md)
## About this config:
There are countless Neovim configurations out there.
Throughout my Neovim config journey, one of the biggest frustrations has been the lack of strict or standardized
architecture—and no universal templates to follow.
Yes, the high-level overview is consistent: Neovim looks for `init.lua` in `$XDG_CONFIG_HOME/nvim`,
and your Neovim environment spawns from there. However, from that point on, things can go in many different directions.
Understanding the *code flow* of other people's Neovim configurations often requires significant time and mental
overhead—depending on their complexity.
Part of my goal in creating this configuration was not only to build something that works best for me,
but also to provide comprehensive and detailed documentation.
This is something others can use and follow when creating their own config—similar in spirit to [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim).
Take what you like from mine; leave what you don’t.
It's my hope that by leaving detailed blueprints, it will be easy for anyone to *leggo* their own Neovim configuration environment.
For more on the architecture of this config, see the docs and illustration here:
**[Config-Structure.md](docs/Config-Structure.md)**
### Enjoy!
# Installation
### Automated script: build Neovim from source, and this Neovim Config
```bash
curl -LO https://raw.githubusercontent.com/LinuxUser255/nvim/refs/heads/main/install.sh && chmod +x install.sh && ./install.sh
```
### The manual way.
```bash
# remove your old neovim config and it's files
rm -rf ~/.config/nvim; rm -rf ~/.local/share/nvim
# git clone this one
git clone https://github.com/LinuxUser255/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
## Supported Languages.
### If you do not have all of these langs installed, the config will still work, but throw errors
- Python3
- Lua
- JavaScript/TypeScript
- HTML/CSS
- Rust
- Go
- C/C++
- Shell Scripting
- JSON/YAML
- Markdown
- Docker
- Solidity
- Vue/Svelte
- TOML
- LaTeX
### - The install script will take care of most of the dependencies; however check your version of Neovim first.
```bash
nvim -v
```
### - Use this config's [install.sh script](install.sh), and all dependencies and Requirements will be automated for you.
### This works too:
### - Change the color theme using the command:
`:colorscheme` use tab to select between tokyo night, (default) and catpuccin.
**Dependencies**
* The repos tend to have older versions. But you can still try it.
* [This config was built using Neovim version 11.2 - And built from source - latest stable version](https://github.com/neovim/neovim/blob/master/BUILD.md)
* And built on Debian 12
* [Using lazy.nvim for plugin management](https://lazy.folke.io/)
* [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
* [ShellCheck](https://github.com/koalaman/shellcheck)
* If you are having issues with [Tree-Sitter](https://github.com/tree-sitter/tree-sitter), then you might not have [node js](https://nodejs.org/en/download) installed. The two quick solution to try are:
* `sudo apt install tree-sitter-cli` if that doesn't work, then you may need to install [Node.js](https://nodejs.org/en/download)
* `sudo apt install nodejs npm` then Install Tree-sitter CLI globally with npm:
* `sudo npm install -g tree-sitter-cli`
* Verify the installation and restart NeoVim
* `tree-sitter --version`
* This config comes configured with [Tabnine Auto Completion](https://github.com/codota/tabnine-nvim)
**Neovim's configurations are located under the following paths, depending on your OS:**
| OS | PATH |
| :---- | :---------------------------------------- |
| Linux | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
## Post Install
**Open Neovim**
---
- The regular way
```sh
nvim
```
- The [netrw](https://neovim.io/doc/user/pi_netrw.html) way
```sh
nvim .
```
- Sync [Lazy](https://lazy.folke.io/)
```sh
nvim --headless "+Lazy! sync" +qa
```
### Netrw - Getting Started - How to use this config
**For details see the [netrw documentation](docs/netrw/netrw-docs.md)**
### Remaps & Shortcuts:
***The spacebar is the leader key***
| Command | Description |
|------------------|----------------------------------------|
| `leader pv` | **Enter Project View** |
| `leader ve` | **Split windows vertically** |
| `leader he` | **Split windows horizontally** |
| `Ctrl l` | **Jumps to the Right window** |
| `Ctrl h` | **Jumps to the Left window** |
| `Ctrl o` | **Increase window width by 3 columns** |
| `Ctrl y` | **Decrease window width by 3 columns** |
| `leader tt` | **Open Telescope** |
| `leader ff` | **Find file using Telescope** |
### Moving lines Up & Down
- Higlight the line, `Shift v`, then while holding down Shift, press `j` to go down
- And `k` to move up.
- This also works with muliple lines selected simultanuiously
| Command | Description |
|----------------------|----------------------------------------|
| `Shift v Shift j` | **Moves seclected line down** |
| `Shift v Shift k` | **Moves seclected line up** |
### Highlight Replace
| Command | Description |
|--------------------------|---------------------------------------------------|
| `Shift s` | **Deletes the line and goes into insert mode.** | |
### Presentations in Neovim
This config includes [present.nvim](https://github.com/tjdevries/present.nvim) for creating presentations in markdown.
| Command | Description |
|------------------|----------------------------------------|
| `leader ps` | **Start presentation mode** |
| `n` | **Next slide (in presentation)** |
| `p` | **Previous slide (in presentation)** |
| `q` | **Quit presentation** |
**Creating Presentations:**
- Write slides in markdown
- Use `` to split slides
- Code blocks can be executed during presentation
- Comments with `%%` won't be shown
## See the cheat sheet below, for more usage info
## [Netrw Cheat Sheet](https://github.com/LinuxUser255/BashAndLinux/tree/main/NeovimCheatSheets)
## [Tabnine Integration Separate Documentation](docs/Tabnine-Integration.md)
