This repository contains my personal Neovim configurations. These settings and plugins enhance the functionality and user experience of Neovim, making it a powerful tool for development.
-
Clone the Repository:
git clone https://github.com/yourusername/nvim-config.git ~/.config/nvim
-
Install Plugins: Open Neovim and run:
:PlugInstall
or the equivalent command for your plugin manager.
-
Restart Neovim: After installation, restart Neovim to apply the changes.
- Neovim: Ensure you have Neovim installed. You can download it from neovim.io.
- Plugin Manager: This configuration uses vim-plug. Make sure you have it installed.
- Dependencies: Some plugins may require additional dependencies. Refer to the respective plugin documentation for more details.
The configuration is structured as follows:
~/.config/nvim/ ├── init.vim # Main configuration file ├── plugins.vim # Plugin configurations ├── mappings.vim # Custom key bindings └── config/ ├── lsp.vim # LSP configurations ├── treesitter.vim # Tree-sitter configurations └── ... # Other specific configurations
markdown
Here are some custom key bindings included in the configuration:
<leader>ff
: Open file finder (Telescope)<leader>fg
: Live grep (Telescope)<leader>fb
: Open buffers (Telescope)<leader>gc
: Git commit<leader>gs
: Git status
Feel free to customize these in mappings.vim
.
This configuration includes the following plugins:
- Telescope - Fuzzy finder
- Nvim-Tree - File explorer
- LSPConfig - Language Server Protocol support
- Tree-sitter - Syntax highlighting and code parsing
- Git Signs - Git integration
For the complete list, refer to plugins.vim
.
To customize this configuration:
- Edit
init.vim
: Modify the main configuration settings. - Edit Plugin Configs: Adjust settings in the respective configuration files in the
config/
directory. - Add/Remove Plugins: Update
plugins.vim
to add or remove plugins as needed.
If you encounter any issues:
- Check Logs: Neovim logs errors in the
:messages
command. - Update Plugins: Ensure all plugins are up-to-date by running
:PlugUpdate
. - Consult Documentation: Refer to the documentation of the specific plugin causing the issue.
If the problem persists, feel free to open an issue in this repository.
Feel free to contribute to this configuration by opening a pull request or submitting an issue.
You can adjust the details and content based on your specific setup and preferences.