https://github.com/kaweees/nvim
🖥️ My custom configurations for neovim with an emphasis on functionality and efficiency
https://github.com/kaweees/nvim
debian dotfiles neovim vim
Last synced: 3 months ago
JSON representation
🖥️ My custom configurations for neovim with an emphasis on functionality and efficiency
- Host: GitHub
- URL: https://github.com/kaweees/nvim
- Owner: Kaweees
- License: gpl-3.0
- Created: 2022-09-08T17:50:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T04:14:53.000Z (almost 2 years ago)
- Last Synced: 2026-01-03T14:38:04.573Z (6 months ago)
- Topics: debian, dotfiles, neovim, vim
- Language: Lua
- Homepage: https://miguelvf.dev/blog/dotfiles/nvim
- Size: 6.44 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
My custom configurations for neovim with an emphasis on functionality and efficiency.
### Built With
[![Neovim][Neovim-shield]][Neovim-url]
[![Lua][Lua-shield]][Lua-url]
[![GitHub Actions][github-actions-shield]][github-actions-url]
## Preview
## Getting Started
### Prerequisites
Before attempting to build this project, make sure you have [Neovim](https://github.com/neovim/neovim/blob/master/INSTALL.md), a [Nerd Font](https://www.nerdfonts.com) installed on your machine, and terminal that supports [24-bit truecolor](https://github.com/termstandard/colors) and Unicode undercurl (special underlines under text).
### Installation
To get a local copy of the project up and running on your machine, follow these simple steps:
1. Clone the project repository
```sh
git clone https://github.com/Kaweees/nvim.git
cd nvim
```
2. Create a symlink from the cloned folder to where neovim expects its configuration to be located. Personally, I use [ansible](https://github.com/Kaweees/ansible/) to create symlinks for all of my [dotfiles](https://github.com/Kaweees/dotfiles/). If you are not sure where it is, check `$XDG_CONFIG_HOME/nvim` or Neovim's configurations are located under the following paths, depending on your OS:
| Operating System | File Path |
| :- | :--- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
| Windows (cmd)| `%userprofile%\AppData\Local\nvim\` |
| Windows (powershell)| `$env:USERPROFILE\AppData\Local\nvim\` |
If you are still unsure, run one of these commands to find out:
```sh
:echo stdpath('config') # Execute while in nvim
:h rtp # Execute while in nvim
```
5. If you want to use the [WakaTime](https://wakatime.com) plugin, configure your API key.
```sh
:WakaTimeApiKey # Execute while in nvim
```
6. If you want to use the [GitHub Copilot](https://github.com/zbirenbaum/lua/) plugin, authenticate your account by executing the following command while in nvim.
```sh
:Copilot auth
```
## Usage
### Available Plugins
* [packer.nvim](https://github.com/wbthomason/packer.nvim/) : This plugin is an easy-to-use plugin manager and installs all of the other plugins listed here.
* [telescope.nvim](https://github.com/pnvim-telescope/telescope.nvim/) : This plugin provides extensible fuzzy finder over lists.
* [harpoon](https://github.com/ThePrimeagen/harpoon2) : This plugin provides a quick way to switch between specific files in a project and execute project specific commands.
* [vim-wakatime](https://github.com/wakatime/vim-wakatime/) : This plugin allows programming activity to automatically be tracked and displayed in your WakaTime dashboard.
* [copilot.lua](https://github.com/zbirenbaum/copilot.lua/) : This plugin provides an efficent way to use GitHub Copilot AI to generate code snippets.
_To see all of the available plugins, please refer to [packer.lua](./lua/config/packer.lua)_
### Keyboard Shortcuts
To enter custom commands into nvim, you must first enter a specific keybind, which is called the leader, followed by the command keybind while in a specific editor mode. My prefix key is space.
To refresh neovim and install new plugins, type leader + I (capital i, as in Install) while in normal mode.
## Project Structure
```sh
~/.config/nvim
├── after/plugins/ - plugin-specific configurations
├── lua
│ ├── config
│ │ ├── lazy.lua - packages installed by lazy.nvim
│ │ ├── remap.lua - keybinds and leader configuration
│ │ └── set.lua - miscellaneous settings
│ └── plugins
│ ├── spec1.lua
│ ├── **
│ └── spec2.lua
├── init.lua - Entry point, loads all plugins and configurations
└── README.md - you are here
```
## License
The source code for my website is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information.
[contributors-shield]: https://img.shields.io/github/contributors/Kaweees/nvim.svg?style=for-the-badge
[contributors-url]: https://github.com/Kaweees/nvim/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Kaweees/nvim.svg?style=for-the-badge
[forks-url]: https://github.com/Kaweees/nvim/network/members
[stars-shield]: https://img.shields.io/github/stars/Kaweees/nvim.svg?style=for-the-badge
[stars-url]: https://github.com/Kaweees/nvim/stargazers
[Neovim-shield]: https://img.shields.io/badge/neovim-%23008080.svg?style=for-the-badge&logo=neovim&logoColor=5fb950&labelColor=222222&color=5fb950
[Neovim-url]: https://neovim.io/
[Lua-shield]: https://img.shields.io/badge/lua-%23008080.svg?style=for-the-badge&logo=lua&logoColor=000080&labelColor=222222&color=000080
[Lua-url]: https://www.lua.org
[github-actions-shield]: https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=2671E5&labelColor=222222&color=2671E5
[github-actions-url]: https://github.com/features/actions