https://github.com/mhkarimi1383/nvim

dotfiles nvim nvim-config vim

Last synced: 4 months ago
JSON representation

Host: GitHub
URL: https://github.com/mhkarimi1383/nvim
Owner: mhkarimi1383
License: mit
Created: 2023-11-12T07:12:13.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-12-27T11:35:37.000Z (6 months ago)
Last Synced: 2025-12-28T09:42:33.245Z (6 months ago)
Topics: dotfiles, nvim, nvim-config, vim
Language: Lua
Homepage:
Size: 224 KB
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# My NVIM configuration

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/mhkarimi1383/nvim/main.svg)](https://results.pre-commit.ci/latest/github/mhkarimi1383/nvim/main)

![Screenshot](./assets/screenshot.png)

> Based on [kickstart.nvim](https://github.com/nvim-lua/kickstart.nvim)

### Installation

> **NOTE**
> Backup your previous configuration (if any exists)

Requirements:
* Make sure to review the readmes of the plugins if you are experiencing errors. In particular:
* [ripgrep](https://github.com/BurntSushi/ripgrep#installation) is required for multiple [telescope](https://github.com/nvim-telescope/telescope.nvim#suggested-dependencies) pickers.
* See [Windows Installation](#Windows-Installation) if you have trouble with `telescope-fzf-native`

Neovim's configurations are located under the following paths, depending on your OS:

Clone this project:

```sh
# on Linux and Mac
git clone https://github.com/mhkarimi1383/nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```

```
# on Windows (cmd)
git clone https://github.com/mhkarimi1383/nvim.git %userprofile%\AppData\Local\nvim\
```

```
# on Windows (powershell)
git clone https://github.com/mhkarimi1383/nvim.git $env:USERPROFILE\AppData\Local\nvim\
```

### Post Installation

Start Neovim

```sh
nvim
```

The `Lazy` plugin manager will start automatically on the first run and install the configured plugins - as can be seen in the introduction video. After the installation is complete you can press `q` to close the `Lazy` UI and **you are ready to go**! Next time you run nvim `Lazy` will no longer show up.

If you would prefer to hide this step and run the plugin sync from the command line, you can use:

```sh
nvim --headless "+Lazy! sync" +qa
```

### Recommended Setup

Font: `Maple Mono NF`
Terminal: `kitty` (with my custom setup at https://github.com/mhkarimi1383/kitty)

### Configuration And Extension

add/modify any required plugin in `lua/custom/plugins/`

this directory is included in `init.lua` by default

You can also merge updates/changes from the repo back into your fork, to keep up-to-date with any changes for the default configuration.

Also inside `init.lua` you can see that nothing has been written directly and we have tried to make this configuration modular with the help of lua modules, etc.
So, do not forget to follow this style :)

### Contribution

1. Fork this project
2. Create a branch for your changes
3. Create PR

### Windows Installation

Installation may require installing build tools, and updating the run command for `telescope-fzf-native`

See `telescope-fzf-native` documentation for [more details](https://github.com/nvim-telescope/telescope-fzf-native.nvim#installation)

This requires:

- Install CMake, and the Microsoft C++ Build Tools on Windows

```lua
{'nvim-telescope/telescope-fzf-native.nvim', build = 'cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release && cmake --build build --config Release && cmake --install build --prefix build' }
```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/mhkarimi1383/nvim

Awesome Lists containing this project

README