What is the purpose of the NvPak project? ✨

Maybe you have tried to configure Neovim multiple times over the past few years. Neovim has undergone many changes, and every time, you had to follow new defaults to reach the minimum configuration and start writing your configuration for Neovim. The goal of the nvpak project is to provide these defaults.

Now you can configure only what you need by forking nvpak without any add-ons. Please note that nvpak is not a Neovim configuration and not in competition with other configurations such as NvChad or LazyVim. If you need a complete Neovim setup without any configuration, then this GitHub repository is not for you.

Why is the name of the project NvPak? 🌟

"nv" stands for Neovim and "Pak" is derived from the Persian word "پاک" meaning "clean," which represents brightness and simplicity, contrary to complexity and disorder.

Requirements 📋

In order to make the best use of this config, you must meet the following prerequisites.

• neovim v0.8.0 and later versions or neovide v0.10.3 and later Version
• unzip
• curl
• ripgrep or fd for Fuzzy Finder Telescope
• For clipboard support:
  • xclip or xsel for Xorg
  • wl-clipboard for Wayland
• git
• If you are a Python developer, pynvim
• bash or dash for Unix-based systems
• PowerShell v5.1 or later for Windows
• Only for Windows: Scoop.sh
• Install Nerd Fonts for better icon support.

Screenshots 📷

Installation 💻

Unix 🐧

bash

git clone --depth 1 https://github.com/Pakrohk-DotFiles/NvPak.git ~/.config/nvim && nvim

Windows 🪟

powershell

bucket add extras
scoop install lazygit
(git clone --depth 1 https://github.com/Pakrohk-DotFiles/NvPak.git ~\AppData\Local\nvim\) -and (nvim)

Notes:

You need to have git installed first. On Unix,nvim command-line executable should be installed.
If it is not installed, you can install it using your system's package manager.
On Windows, you need to have scoop installed first.
Then, install lazygit by running scoop install lazygit.
Afterwards, run the remaining commands sequentially.

The --depth 1 option of the git clone command fetches only the latest changes from the repository and does not retrieve the entire history.
This reduces the download time.
The \ character in Windows is used to continue a command on a new line.

Usage: 🚀

If the software plugins are not installed automatically after the first run, follow these steps:

Run the following command inside nvim:

:Lazy sync

Restart nvim.

Enjoy!

Contributing 🤝

If you're interested in contributing to the project, we welcome your help in fixing bugs and adding new features.
Here's how you can get started:

Check the Projects section to see if there are any open issues or features that you'd like to work on.
If you have an idea for a new feature or improvement, feel free to suggest it and discuss it with the NvPak team.

Fork the NvPak repository to your own GitHub account.
Make your changes and commit them to your forked repository. Please make sure to follow the project's coding standards and best practices, and write clear and concise commit messages.

Submit a pull request from your forked repository to the main NvPak repository.
Your changes will be reviewed by the NvPak team, who may provide feedback and request changes if necessary.
Once your changes are approved, they will be merged into the main NvPak repository and will be available to all users.

By contributing to NvPak, you'll be helping to improve the project for all users, and you'll have the opportunity to learn and collaborate with other developers.

Thank you for considering contributing to NvPak!

you can find the list of contributors on the contributors page.

Team