Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/caincarmo/kin.nvim

πŸŒ™ - My config for neovim
https://github.com/caincarmo/kin.nvim

lua neovim neovim-config neovim-setup

Last synced: 8 days ago
JSON representation

πŸŒ™ - My config for neovim

Awesome Lists containing this project

README

        

🍑 Kin.nvim


These are my settings for Neovim.


---

## 🚧 Requirements

- Git
- Neovim >= 9.5
- Tools
- fzf
- ripgrep
- Clipboard Tool (necessary for the integration with the system clipboard)
- Package Managers
- Pip
- Npm
- Cargo
- LuaRocks (optional)
- Powershell 7 or higher (for Windows user)

## πŸ› οΈ Installation

### > Linux/Mac OS (Unix)

1. Make a backup of your current nvim and shared folder

```sh
mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak
```

2. Clone this repo

```sh
git clone --depth 1 https://github.com/CainCarmo/Kin.nvim ~/.config/nvim
rm -rf ~/.config/nvim/.git
rm -rf ~/.config/nvim/.gitignore
nvim
```

### > Windows (Powershell)

1. Make a backup of your current nvim and nvim-data folder

```pwsh
Rename-Item -Path $env:LOCALAPPDATA\nvim -NewName $env:LOCALAPPDATA\nvim.bak
Rename-Item -Path $env:LOCALAPPDATA\nvim-data -NewName $env:LOCALAPPDATA\nvim-data.bak
```

2. Clone this repo

```pwsh
git clone --depth 1 https://github.com/AstroNvim/template $env:LOCALAPPDATA\nvim
Remove-Item $env:LOCALAPPDATA\nvim\.git -Recurse -Force
Remove-Item $env:LOCALAPPDATA\nvim\.gitignore -Recurse -Force
nvim
```

## File Structure

You may add your plugin in `lua/user/plugins` or `lua/user/plugins/langs`. All files there
will be automatically loaded by [lazy.nvim](https://github.com/folke/lazy.nvim)

```txt
~/.config/nvim
β”œβ”€β”€ lua
β”‚ └── user
β”‚ β”œβ”€β”€ config
β”‚ β”‚ β”œβ”€β”€ autocmds.lua
β”‚ β”‚ β”œβ”€β”€ keymaps.lua
β”‚ β”‚ β”œβ”€β”€ knvim.lua
β”‚ β”‚ └── options.lua
β”‚ β”œβ”€β”€ helpers
β”‚ β”‚ └── extensions
β”‚ β”‚ └── table.lua
β”‚ β”œβ”€β”€ interface
β”‚ β”‚ β”œβ”€β”€ ascii.lua
β”‚ β”‚ └── icons.lua
β”‚ β”œβ”€β”€ packager
β”‚ β”‚ └── init.lua
β”‚ β”œβ”€β”€ plugins
β”‚ β”‚ β”œβ”€β”€ langs
β”‚ β”‚ β”‚ β”œβ”€β”€ spec1.lua
β”‚ β”‚ β”‚ β”œβ”€β”€ spec2.lua
β”‚ β”‚ β”‚ └── ...
β”‚ β”‚ β”œβ”€β”€ spec1.lua
β”‚ β”‚ β”œβ”€β”€ spec2.lua
β”‚ β”‚ └── ...
β”‚ └── resources
β”‚ └── lspconfig
β”‚ β”œβ”€β”€ jsonls.lua
β”‚ β”œβ”€β”€ lua_ls.lua
β”‚ └── yamlls.lua
β”‚
└── init.lua
```

## Credits

The development of Kin.nvim was inspired by incredible projects that have my sincere thanks to the following repositories:

- [NvChad](https://github.com/NvChad/NvChad)
- [LunarVim](https://github.com/LunarVim/LunarVim)
- [LazyVim](https://github.com/LazyVim/LazyVim)

> Β© 2024 CainΓ£ Carmo