/NvPak

A clean config for neovim to be of particular complexity

Primary LanguageLuaOtherNOASSERTION

APACHEv3 license Maintenance Neovim Minimum Version Maintainer GitHub Issues

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 📷

Show

full

autocompelet

NeoVide

Fuzzy Finder

CmdLine

show error and warns details

Installation 💻

Unix 🐧:

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

Windows 🪟:

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

Usage 🚀

If the software plugins are not installed automatically after the first run, proceed as follows:

  1. Run the following command inside nvim:

    :Lazy sync
  2. Restart nvim and enjoy!

Contributing 🤝

Do you intend to help the progress of the project? If you want to contribute, you can help us by solving bugs and adding features.

To get started, please follow these steps:

  1. Visit the Projects section to select a bug or feature to work on.
  2. Create a fork of the NvPak repository.
  3. Submit a pull request and wait for the NvPak team's review and approval.