https://github.com/powerman/config.nvim
My personal nvim configuration
https://github.com/powerman/config.nvim
Last synced: 11 months ago
JSON representation
My personal nvim configuration
- Host: GitHub
- URL: https://github.com/powerman/config.nvim
- Owner: powerman
- License: mit
- Created: 2024-06-28T22:06:33.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-16T21:08:30.000Z (about 1 year ago)
- Last Synced: 2025-02-15T05:52:34.166Z (11 months ago)
- Language: Lua
- Size: 1 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ~/.config/nvim
## Introduction
This is my Neovim config.
> [!NOTE]
> It was started as a fork of
> [dam9000/kickstart-modular.nvim](https://github.com/dam9000/kickstart-modular.nvim) and I
> highly recommend it if you like to create your own config yourself (like I did). I do not
> support this config on Windows, but it might work - check that kickstart repo for
> Windows-specific install instructions.
## Installation
### Install Neovim
Config.nvim targets _only_ the latest
['stable'](https://github.com/neovim/neovim/releases/tag/stable) Neovim.
If you are experiencing issues, please make sure you have the latest version.
### Install External Dependencies
External Requirements:
- Basic utils: `git`, `make`, `unzip`, C Compiler (`gcc`).
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation).
- Clipboard tool (xclip/xsel or other depending on platform).
- A [Nerd Font](https://www.nerdfonts.com/): optional, provides various icons.
- If you have it set `vim.g.have_nerd_font` in `init.lua` to true.
- If you chose "Mono" font kind set `vim.g.mono_nerd_font` in `init.lua` to true.
- Language setup:
- If want to write Typescript, you need `npm`
- If want to write Golang, you will need `go`
- etc.
- Setup formatters for file types you need:
- Check/update list of tools configured in `lua/plugins/conform.lua`.
- Install/setup these tools.
### Install Config
> [!NOTE]
>
> [Backup](#faq) your previous configuration (if any exists)
Neovim's configurations are located under the following paths, depending on your OS:
| OS | PATH |
| :----------- | :---------------------------------------- |
| Linux, MacOS | `$XDG_CONFIG_HOME/nvim`, `~/.config/nvim` |
#### Recommended Step
[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repo
so that you have your own copy that you can modify, then install by cloning the
fork to your machine using one of the commands below, depending on your OS.
> [!NOTE]
> Your fork's url will be something like this:
> `https://github.com//config.nvim.git`
#### Clone config.nvim
> [!NOTE]
> If following the recommended step above (i.e., forking the repo), replace
> `powerman` with `` in the commands below
Linux and Mac
```sh
git clone https://github.com/powerman/config.nvim.git "${XDG_CONFIG_HOME:-$HOME/.config}"/nvim
```
### Post Installation
Start Neovim
```sh
nvim
```
That's it! Lazy will install all the plugins you have. Use `:Lazy` to view
current plugin status. Hit `q` to close the window.
If you are on another machine, you can do `:Lazy restore`, to update all your plugins to the
version from the lockfile.
### Getting Started
[The Only Video You Need to Get Started with Neovim](https://youtu.be/m8C0Cq9Uv9o)
### FAQ
- What should I do if I already have a pre-existing neovim configuration?
- You should back it up and then delete all associated files.
- This includes your existing init.lua and the neovim files in `~/.local`
which can be deleted with `rm -rf ~/.local/share/nvim/`
- Can I keep my existing configuration in parallel?
- Yes! You can use [NVIM_APPNAME](https://neovim.io/doc/user/starting.html#_nvim_appname)`=nvim-NAME`
to maintain multiple configurations. For example, you can install the
configuration in `~/.config/nvim-powerman` and create an alias:
```sh
alias nvim-powerman='NVIM_APPNAME="nvim-powerman" nvim'
```
When you run Neovim using `nvim-powerman` alias it will use the alternative
config directory and the matching local directory
`~/.local/share/nvim-powerman`. You can apply this approach to any Neovim
distribution that you would like to try out.
### Install Recipes
Below you can find OS specific install instructions for Neovim and dependencies.
After installing all the dependencies continue with the [Install Config](#install-config) step.
#### Linux Install
Ubuntu Install Steps
```sh
sudo add-apt-repository ppa:neovim-ppa/unstable -y
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip neovim
```
Debian Install Steps
```sh
sudo apt update
sudo apt install make gcc ripgrep unzip git xclip curl
# Now we install nvim
curl -LO https://github.com/neovim/neovim/releases/latest/download/nvim-linux64.tar.gz
sudo rm -rf /opt/nvim-linux64
sudo mkdir -p /opt/nvim-linux64
sudo chmod a+rX /opt/nvim-linux64
sudo tar -C /opt -xzf nvim-linux64.tar.gz
# make it available in /usr/local/bin, distro installs to /usr/bin
sudo ln -sf /opt/nvim-linux64/bin/nvim /usr/local/bin/
```
Fedora Install Steps
```sh
sudo dnf install -y gcc make git ripgrep fd-find unzip neovim
```
Arch Install Steps
```sh
sudo pacman -S --noconfirm --needed gcc make git ripgrep fd unzip neovim
```