Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sheenazien8/nvimconfig
My neovim configuration
https://github.com/sheenazien8/nvimconfig
Last synced: about 2 months ago
JSON representation
My neovim configuration
- Host: GitHub
- URL: https://github.com/sheenazien8/nvimconfig
- Owner: sheenazien8
- Created: 2024-06-08T10:14:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-07-16T22:33:44.000Z (6 months ago)
- Last Synced: 2024-07-17T02:44:20.889Z (6 months ago)
- Language: Lua
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim Configuration
This repository contains my Neovim configuration files. My setup uses Lua for configuration, with Lazy.nvim for managing plugins and Gruvbox as the theme.
## Table of Contents
- [Installation](#installation)
- [Plugins](#plugins)
- [Configuration Structure](#configuration-structure)
- [Key Mappings](#key-mappings)
- [Custom Functions](#custom-functions)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)
## Installation
### Prerequisites
- Neovim (v0.11 or later)
- Git
### Steps
1. Clone this repository:
```sh
git clone https://github.com/sheenazien8/nvimconfig ~/.config/nvim
```
2. Install plugins:
Open Neovim and run:
```vim
:Lazy install
```
3. Restart Neovim.
## Plugins
This configuration uses Lazy.nvim to manage plugins. Here are some of the key plugins included:
- [Lazy.nvim](https://github.com/folke/lazy.nvim): A plugin manager for Neovim.
- [Gruvbox](https://github.com/ellisonleao/gruvbox.nvim): A retro groove color scheme for Vim.
- [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter): Treesitter configurations and abstraction layer for Neovim.
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim): A highly extendable fuzzy finder over lists.
## Configuration Structure
The configuration files are organized as follows:
```
~/.config/nvim/
├── init.lua # Main configuration file
├── lua/
│ ├── config/ # Plugin configurations
│ ├── custom/ # Custom Lua functions and scripts
│ ├── plugins/ # Neovim settings and options
| └── init.lua # Bootsrap all the configuration
```
### Example `init.lua`
```lua
require "init"
```
## Key Mappings
Key mappings are defined in the `lua/config/keymap.lua` file. Here are some of the key mappings included:
- `sf`: Find files using Telescope
- `sg`: Live grep using Telescope
- `sb`: List buffers using Telescope
## Custom Functions
Custom functions are defined in the `lua/custom/` directory. These functions extend the functionality of Neovim and are used throughout the configuration.
## Screenshots
Here are some screenshots of my Neovim setup:
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or improvements.
## License
This configuration is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
---
Feel free to adjust the Markdown formatting as needed for your repository.