Skip to content

README.md

Latest commit

 

History

History
138 lines (97 loc) · 5.84 KB

README.md

File metadata and controls

138 lines (97 loc) · 5.84 KB

TurboNvim

TurboNvim is an excellent Neovim configuration with lazy.nvim , which is as powerful as Vscode, is lightning fast ⚡

🌟 Preview

Dashboard Preview Image Coding Preview Image Float Term Image Find Files Image Live Grep Image Lazy Git Image Float Ranger Image NavBuddy Image

✨ Features

⚡ Requirements

  • Nerd Fonts
  • Neovim 0.8+ (Including nightly)
  • Tree-sitter CLI (Note: This is only necessary if you want to use auto_install feature with Treesitter)
  • A clipboard tool is necessary for the integration with the system clipboard (see :help clipboard-tool for supported solutions)
  • Terminal with true color support (for the default theme, otherwise it is dependent on the theme you are using) [2]
  • Optional Requirements:
    • ripgrep - live grep telescope search (<leader>fg)
    • lazygit - git ui toggle terminal (<leader>tg)

[1] All downloadable Nerd Fonts contain icons which are used by TurboNvim. Install the Nerd Font of your choice to your system and in your terminal emulator settings, set its font face to that Nerd Font. If you are using TurboNvim on a remote system via SSH, you do not need to install the font on the remote system.

[2] Note when using default theme: For MacOS, the default terminal does not have true color support. You will need to use iTerm2, Kitty, WezTerm, or another terminal emulator that has true color support.

🛠️ Installation

Linux/Mac OS (Unix)

Make a backup of your current nvim and shared folder

mv ~/.config/nvim ~/.config/nvim.bak
mv ~/.local/share/nvim ~/.local/share/nvim.bak

Clone the repository

git clone --depth 1 https://github.com/a1401358759/TurboNvim ~/.config/nvim
nvim

Windows (Powershell)

Make a backup of your current nvim and nvim-data folder

Rename-Item -Path $env:LOCALAPPDATA\nvim -NewName $env:LOCALAPPDATA\nvim.bak
Rename-Item -Path $env:LOCALAPPDATA\nvim-data -NewName $env:LOCALAPPDATA\nvim-data.bak

Clone the repository

git clone --depth 1 https://github.com/a1401358759/TurboNvim $env:LOCALAPPDATA\nvim
nvim

📦 Basic Setup

Install LSP

Enter :LspInstall followed by the name of the server you want to install
Example: :LspInstall pyright

Install language parser

Enter :TSInstall followed by the name of the language you want to install
Example: :TSInstall python

Install Debugger

Enter :DapInstall followed by the name of the debugger you want to install
Example: :DapInstall python

Manage plugins

Run :Lazy check to check for plugin updates

Run :Lazy update to apply any pending plugin updates

Run :Lazy clean to remove any disabled or unused plugins

Run :Lazy sync to update and clean plugins

⭐ Credits

Sincere appreciation to the following repositories, plugin authors and the entire neovim community out there that made the development of TurboNvim possible.

Lua