Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knid/nvim
My personal neovim configuration with a beautiful ui powered by many powerful plugins like Telescope, nvim-tree, lspconfig. Completely written in lua.
https://github.com/knid/nvim
lua neovim nvim nvim-configs nvim-configuration vim vim-configuration
Last synced: 11 days ago
JSON representation
My personal neovim configuration with a beautiful ui powered by many powerful plugins like Telescope, nvim-tree, lspconfig. Completely written in lua.
- Host: GitHub
- URL: https://github.com/knid/nvim
- Owner: knid
- License: mit
- Created: 2022-11-24T15:02:45.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T13:54:22.000Z (14 days ago)
- Last Synced: 2024-10-25T16:52:00.528Z (13 days ago)
- Topics: lua, neovim, nvim, nvim-configs, nvim-configuration, vim, vim-configuration
- Language: Lua
- Homepage:
- Size: 5.31 MB
- Stars: 37
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
KnidNvim
## Showcase
## Contents
- [About](#about)
- [Requirements](#requirements)
- [Installation](#installation)
- [Update](#update)
- [Configuration](#configuration)
- [Install LSP Servers](#install-lsp-servers)
- [Built-in Commands](#built-in-commands)
- [Mappings](#mappings)
- [Change Theme](#change-theme)
- [Add Plugins](#add-plugins)
- [Suppport](#support)
### About
- KnidNvim is my personal neovim configuration with a beautiful ui powered by many powerful plugins like
Telescope, nvim-tree, lspconfig. Completely written in lua.
- KnidNvim has about 10+ beautiful themes. You can add more or customize anything.
- KnidNvim is a base configuration for neovim. You can extend or something but if you
want to do small changes you can edit lua/knid/config.lua file.
KnidNvim tried to simplify customization for you.
### Requirements
- [Neovim](https://neovim.io/) (>= 0.8)
- [Node](https://nodejs.org/)
- [Use a nerd font](https://www.nerdfonts.com) in your terminal
- Make sure to delete this folder `~/.local/share/nvim`
- (Optional) [ripgrep](https://github.com/BurntSushi/ripgrep) is required for grep searching with Telescope.
### Installation
```bash
git clone https://github.com/knid/nvim ~/.config/nvim && nvim +KnidInstall
```
Restart nvim after finished.
### Update
Run `:KnidUpdate` in neovim or run `nvim +KnidUpdate` in your terminal.
### Configuration
You can configure KnidNvim with just **one file.**
For open run `:KnidConfig` or press `es`
**Note:** Default leader: `` key
```lua
Config = {
leader = " ",
theme = 'onedark', -- Available Themes: onedark, aquarium, ayu, everforest, nightfox, dayfox, dawnfox, duskfox, terafox, carbonfox
transparent = false,
...
lsp = {
auto_format = true,
colors = {
error = '#db4b4b',
warning = '#e0af68',
...
map = {
custom = {
{ 'n', 'sayhi', function() print('hi :>') end }
}
}
...
}
return Config
```
#### Install LSP servers
Run `:Mason` and install with gui
or
```bash
:MasonInstall
```
#### Built-in commands
- `:Run` mapping: `r`
- The command run a program in neovim buffer. It can be auto detect file type and run.
- Its still in development and just support few languages (c, rust, python, c++, js)
- `:KnidInstall`
- The command install KnidNvim
- `:KnidUpdate`
- The command update KnidNvim
#### Mappings
Default mappings.
lua/knid/core/default_maps.lua
You can add more by editing lua/knid/core/custom_maps.lua file.
OR using lua/knid/config.lua file
```lua
Config = {
...
map = {
disable_default = false,
custom = {
{ 'n', 'sayhi', function() print('hi :>') end }
}
}
...
}
```
#### Change Theme
Change the `theme` variable in lua/knid.config.lua
```lua
Config = {
...
theme = 'nightfox',
-- Available Themes: onedark, aquarium, ayu, everforest, nightfox, dayfox,
-- dawnfox, duskfox, terafox, carbonfox
transparent = false,
...
}
```
If you want to make transparent ui change the `transparent` variable.
#### Add plugins
KnidNvim use `packer` for plugin management.
You can see plugin list and add plugins by editing lua/knid/plugins/list.lua
## Support
If you wanna support my work here is the donation links
