Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coleellis/lazytown-nvim

A minimalist, easy-to-expand Neovim configuration for all users
https://github.com/coleellis/lazytown-nvim

lua neovim neovim-conf nvim rice vim

Last synced: 3 months ago
JSON representation

A minimalist, easy-to-expand Neovim configuration for all users

Awesome Lists containing this project

README

        

LazyTown-nvim


Home

Install

Plugins

[![Neovim Minimum Version](https://img.shields.io/badge/Neovim-0.10-blueviolet.svg?style=flat-square&logo=Neovim&color=90E59A&logoColor=white)](https://github.com/neovim/neovim)
[![GitHub Issues](https://img.shields.io/github/issues/coleellis/lazytown-nvim.svg?style=flat-square&label=Issues&color=d77982)](https://github.com/thecae/lazytown-nvim/issues)

## Showcase

![LazyTown](./images/lazytown.png)

## What is LazyTown?

LazyTown is a lua-based Neovim configuration with expandability in mind. All configurations are well-documented, easy to change, and easy to add more plugins.

## Installation

Requirements:

- [Neovim 0.10](https://github.com/neovim/neovim/releases/tag/v0.10.0).
- [Nerd Font](https://www.nerdfonts.com/) as your terminal font.
- Make sure the nerd font you set doesn't end with Mono to prevent small icons.
- Example: _Cascaydia Code Nerd Font_ and not _Cascaydia Code Nerd Font Mono_
- [Ripgrep](https://github.com/BurntSushi/ripgrep) is required for grep searching with Telescope (_optional_).
- GCC, Windows users must have [`mingw`](http://mingw-w64.org/downloads) installed and set on path.
- Make, Windows users must have [`GnuWin32`](https://sourceforge.net/projects/gnuwin32) installed and set on path.
- Delete old neovim folders (check commands below)

This repository is ready by default. Simply clone it into the `~/.config/nmvim` folder:

```bash
git clone https://github.com/thecae/lazytown-nvim.git ~/.config/nvim
```

Remove the `.git` folder so you can add your own:

```bash
rm -rf ~/.config/nvim/.git
```

Run `nvim`, install the LSPs, and update packages!

```bash
nvim

:Mason # install LSPs and DAPs
:Lazy sync
```

## Plugins List

- An easy to configure dashboard from [nvim-dashboard](https://github.com/nvimdev/dashboard-nvim).
- Powerful, fast LSP configurations using [mason-nvim](https://github.com/williamboman/mason.nvim) and [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
- Code formatting with [conform.nvim](https://github.com/stevearc/conform.nvim) and [none-ls.nvim](https://github.com/nvimtools/none-ls.nvim).
- Diagnostics, outlines, and other tooling from [trouble.nvim](https://github.com/folke/trouble.nvim) and [outline.nvim](https://github.com/hedyhli/outline.nvim).
- Live grep and file-finding with [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter).
- Informative, customizable powerline from [lualine](https://github.com/nvim-lualine/lualine.nvim).
- An all-in-one IDE-like display from [edgy.nvim](https://github.com/folke/edgy.nvim).
- Autocompletion with [nvim-cmp](https://github.com/hrsh7th/nvim-cmp).
- File tree integration with [neo-tree](https://github.com/nvim-neo-tree/neo-tree.nvim).
- Easy git integration with [gitsigns](https://github.com/lewis6991/gitsigns.nvim), [git-blame.nvim](https://github.com/f-person/git-blame.nvim), and [octo.nvim](https://github.com/pwntester/octo.nvim).
- Beautiful icons from [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons).
- Keymap popup cheatsheets with [which-key](https://github.com/folke/which-key.nvim).

## Credits

This configuration stems takes inspiration from the base LazyVim installation but simplifies the plugin structure to allow developers to understand the installed plugins, remove what they don't want, and add what they need.

Additional inspiration is taken from ThePrimagen's 0 to LSP series, typecraft's 0 to LSP series, and various Neovim configurations on Reddit.

You can find some good configurations to expand your configuration from [Awesome Neovim](https://github.com/rockerBOO/awesome-neovim)!