https://github.com/redjax/neovim
My neovim config. Codeberg mirror: https://codeberg.org/redjax/neovim
https://github.com/redjax/neovim
debian linux lua lua-script neovim neovim-config neovim-configs neovim-configuration nvim nvim-config nvim-configs redhat ubuntu windows windows-11 wsl
Last synced: about 2 months ago
JSON representation
My neovim config. Codeberg mirror: https://codeberg.org/redjax/neovim
- Host: GitHub
- URL: https://github.com/redjax/neovim
- Owner: redjax
- Created: 2024-12-17T19:01:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-01T07:05:19.000Z (about 1 year ago)
- Last Synced: 2025-01-01T08:17:21.599Z (about 1 year ago)
- Topics: debian, linux, lua, lua-script, neovim, neovim-config, neovim-configs, neovim-configuration, nvim, nvim-config, nvim-configs, redhat, ubuntu, windows, windows-11, wsl
- Language: Lua
- Homepage:
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim Configuration
My `neovim` configurations as a git repository.
> * 🔗 [View all releases](https://github.com/redjax/neovim/releases)
> * [Read more about how this repository creates releases](#releases)
> * 📕 [Read the documentation](./docs/README.md)
## Table of Contents
- [Releases](#releases)
- [Instructions](#instructions)
- [Usage](#usage)
- [Updating](#updating)
- [Notes](#notes)
- [Links](#links)
## Releases
This repository releases .zip archives of the [neovim configurations in `config/`](./config). The [release pipeline](./.github/workflows/release.yml) is triggered manually, and creates the next patch version automatically (i.e. `v0.0.1` -> `v0.0.2`).
Each time a release is created, it will contain .zip archives of each configuration, named after the directory (i.e. `nvim-v0.0.1.zip` for the [default `nvim/` config](./config/nvim/)). When you extract the archive, a directory named `nvim/` will be created, containing the configuration you downloaded. You can move this file to the Neovim configuration path (`~/.config/nvim` on Linux, `%USERPROFILE%\AppData\Local\nvim` on Windows) to install the configuration. You can also extract the .zip archive directly to that path to extract & install in 1 step.
## Instructions
*[View installation documentation](./docs/INSTALL.md)*
- Clone repository with `git clone git@github.com:redjax/neovim` (or with HTTPS: `git clone https://github.com/redjax/neovim ./neovim`)
- Run the setup script for your platform:
- [Linux](./docs/INSTALL.md#linux)
- [Windows](./docs/INSTALL.md#windows)
- Run `nvim` to ensure everything installed correctly.
- Read the [First Run documentation](./docs/USAGE.md#first-run) for more information on the errors you will probably see the first couple of times you run Neovim.
- (Optional) Change the [neovim configuration](./config/) to use by setting the `NVIM_APPNAME` var.
- Read [Switching profiles](./docs/USAGE.md#switching-profiles) to learn how to use the `$NVIM_APPNAME` environment variable.
> [!NOTE]
> You can also run `nvim --headless '+Lazy! sync' '+Lazy! clean' +qa` to automatically run a Sync and Clean operation, then quit Neovim.
> The `--headless` flag will prevent the main `neovim` window from opening, instead showing you the output as log lines.
>
> There is a script for [Windows](./scripts/windows/lazy-sync.ps1) and [Linux](./scripts/linux/lazy-sync.sh) that will run this operation
> for the [`nvim`](./config/nvim/) and [`nvim-work`](./config/nvim-work/) profiles, or you can pass 1 or more `-p/--profile ` to customize which lockfiles are updated.
## Usage
*[View usage documentation](./docs/USAGE.md)*
## Updating
*[View Neovim app update documentation](./docs/USAGE.md#update-neovim-app)*
*[View Neovim configuration update documentation](./docs/USAGE.md#updating-neovim-configuration)*
*[View Neovim plugin update documentation](./docs/USAGE.md#updating-plugins)*
## Notes
*[View notes documentation](./docs/NOTES.md)*
## Links
*[View links documentation](./docs/LINKS.md)*