https://github.com/liraymond04/nvim

My personal neovim configuration
https://github.com/liraymond04/nvim

arch-linux configuration dotfiles linux lua neovim vim

Last synced: 29 days ago
JSON representation

My personal neovim configuration

• Host: GitHub
• URL: https://github.com/liraymond04/nvim
• Owner: liraymond04
• Created: 2022-07-20T03:17:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-29T07:46:32.000Z (3 months ago)
• Last Synced: 2025-01-19T13:17:04.717Z (about 1 month ago)
• Topics: arch-linux, configuration, dotfiles, linux, lua, neovim, vim
• Language: Lua
• Homepage:
• Size: 109 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nvim

My personal [neovim](https://github.com/neovim/neovim) configuration

Used as a submodule in my main [dotfiles](https://github.com/liraymond04/.dotfiles) repository

## Structure

Document points of interest in config file structure

```

nvim/               // root

├─ lua/

│  ├─ core/         // main vim configs

│  ├─ plugins/

│  │  ├─ configs/   // plugin setup

│  │  ├─ utils/

├─ init.lua         // entry point

```

### core

 - init.lua - loads in user options and handles basic flow

 - autocommands.lua - creates autocommands and augroups

 - keymaps.lua - user defined key mappings

 - options.lua - user defined vim options

 - plugins.lua - plugin install and setup

### plugins

 - init.lua - returns

 table of plugins to install

 - setup.lua - include file for plugin configuration and setup

 - configs/ - contains

 configuration and setup for plugins

 - utils/ - contains utility functions not part of plugin setup

 

## Tips

 - Commenting out the `requires "core"` in the root `init.lua` disables the configuration (same as using unconfigured Neovim)

 - Commenting out `requires "core.plugins"` in `core/init.lua` disables user installed plugins

 - Individual plugins can be disabled by commenting out their requires lines in `plugins/setup.lua`

    - Note: `tpope/vim-sleuth` is an exception, it's not a Lua plugin and is loaded by the package manager

 - Plugins can be installed by adding a plugin's repo `[author]/[repo-name]` to the lua table in `plugins/init.lua`

## Setup

### Arch Linux

Install `nvim` and `make`

```bash

sudo pacman -S nvim make

```

If copy and paste doesn't work, install `xsel`

```bash

sudo pacman -S xsel

```

Open Neovim with the `nvim` command

```bash

nvim

```

Plugins, language servers, and treesitter parsers should be installed when entering `nvim` for the first time (may need a restart after installation is complete)