Files
neovim-config/README.md
T
rootiest 84f12e6524 🖼️ NeoVIM Logo
- Add a logo to
  - README
  - init.lua
2024-07-08 16:14:40 -04:00

5.9 KiB

Rootiest NeoVim Configuration

██████╗  ██████╗  ██████╗ ████████╗██╗███████╗███████╗████████╗
██╔══██╗██╔═══██╗██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝╚══██╔══╝
██████╔╝██║   ██║██║   ██║   ██║   ██║█████╗  ███████╗   ██║
██╔══██╗██║   ██║██║   ██║   ██║   ██║██╔══╝  ╚════██║   ██║
██║  ██║╚██████╔╝╚██████╔╝   ██║   ██║███████╗███████║   ██║
╚═╝  ╚═╝ ╚═════╝  ╚═════╝    ╚═╝   ╚═╝╚══════╝╚══════╝   ╚═╝
    ███╗   ██╗███████╗ ██████╗ ██╗   ██╗██╗███╗   ███╗
    ████╗  ██║██╔════╝██╔═══██╗██║   ██║██║████╗ ████║
    ██╔██╗ ██║█████╗  ██║   ██║██║   ██║██║██╔████╔██║
    ██║╚██╗██║██╔══╝  ██║   ██║╚██╗ ██╔╝██║██║╚██╔╝██║
    ██║ ╚████║███████╗╚██████╔╝ ╚████╔╝ ██║██║ ╚═╝ ██║

                  ________ ++     ________
                /VVVVVVVV\++++  /VVVVVVVV\
                \VVVVVVVV/++++++\VVVVVVVV/
                  |VVVVVV|++++++++/VVVVV/'
                  |VVVVVV|++++++/VVVVV/'
                +|VVVVVV|++++/VVVVV/'+
              +++|VVVVVV|++/VVVVV/'+++++
            +++++|VVVVVV|/VVV___++++++++++
              +++|VVVVVVVVVV/##/ +_+_+_+_
                +|VVVVVVVVV___ +/#_#,#_#,\
                  |VVVVVVV//##/+/#/+/#/'/#/
                  |VVVVV/'+/#/+/#/+/#/ /#/
                  |VVV/'++/#/+/#/ /#/ /#/
                  'V/'  /##//##//##//###/
                          ++

The rootiest neovim configuration you will ever see!

Installation

  1. Install neovim

  2. Install Pre-requisites

    • Required

    • Optional (but recommended for the full experience)

      • ripgrep - A faster grep
      • fzf - A command-line fuzzy finder
      • fd - A simple, fast and user-friendly alternative to 'find'
      • lazygit - A simple terminal UI for git commands
      • tree-sitter - A parser generator tool and an incremental parsing library
      • kitty - A fast, featureful, GPU based terminal emulator
      • neovide - A simple, fast, featureful, and modern neovim GUI
      • fish - A smart and user-friendly command line shell
  3. Backup your current nvim configuration (if you have one)

    mv ~/.config/nvim ~/.config/nvim.bak
    
  4. Clone the repository

    git clone https://github.com/rootiest/rootiest-nvim.git ~/.config/nvim
    
  5. Enjoy! 🎉

Features

  • Comfortable keybindings and IDE-like features
  • Designed to be quick to load and easy to use without compromising on features
  • Leans heavily on lazy and luarocks for plugin management and lazy-loading
  • Catppuccino theme is default but tokyonight and ayu are also included
  • Automatic light/dark mode switching based on system theme
  • Extensive special configurations for kitty, including theme matching
  • Image support for kitty when conditions are met
  • Kitty scrollback and keybinding support
  • Special configuration for neovide
  • Detects terminal client and adjusts accordingly
  • Detects SSH sessions and disables certain plugins for speed and compatibility
  • ToggleTerm, fzf, telescope, neotree, etc. for quick access to files and terminal
  • Many UI elements to enhance the experience
  • LSP support for many languages and automatic setup for many more
  • Remotely spawn a neovim instance over ssh, in a container, or from a git repo
  • Dashboard logo adjusts to the size of the window
  • Codeium-powered AI completion

Notes

You may notice that some plugins or alternative colorschemes do not initially appear in the command list.

This is expected. Neovim will load them on demand.
This allows for a leaner and faster-loading experience.

Companion Tools

Rootiest Kitty Conf - A kitty configuration that is designed to work with this neovim configuration

Rootiest Fish Conf - A fish configuration that pairs well with this neovim configuration

Nerd Fonts - A collection of fonts that include many icons and glyphs that are used in this configuration. The default font used throughout the config is Monaspace Krypton. Further, kitty uses the Symbols Only Nerd Font to ensure compatibility with any font.

Credits