AstroNvim

Install · Configure · Community Plugins · Docs · Discord

AstroNvim is an aesthetic and feature-rich neovim config that is extensible and easy to use with a great set of plugins

🌟 Preview

✨ Features

File explorer with Neo-tree
Autocompletion with Cmp
Git integration with Gitsigns
Statusline, Winbar, and Bufferline with Heirline
Terminal with Toggleterm
Fuzzy finding with Telescope
Syntax highlighting with Treesitter
Formatting and Linting with Null-ls
Language Server Protocol with Native LSP
Debug Adapter Protocol with nvim-dap

⚡ Requirements

Nerd Fonts (Optional with manual intervention: See Documentation on customizing icons)
Neovim 0.8+ (Not 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)
Optional Requirements:
- ripgrep - live grep telescope search (<leader>fw)
- lazygit - git ui toggle terminal (<leader>tl or <leader>gg)
- go DiskUsage() - disk usage toggle terminal (<leader>tu)
- bottom - process viewer toggle terminal (<leader>tt)
- Python - python repl toggle terminal (<leader>tp)
- Node - node repl toggle terminal (<leader>tn)

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

🛠️ Installation

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/AstroNvim/AstroNvim ~/.config/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

Update AstroNvim

Run :AstroUpdate to get the latest updates from the repository

Update AstroNvim Packages

Run :AstroUpdatePackages (<leader>pa) to update both Neovim plugins and Mason packages

🗒️ Links

AstroNvim Documentation Core AstroNvim LUA API Documentation

Basic Usage is given for basic usage
Default Mappings more about the default key bindings
Default Plugin Configuration more about the provided plugin defaults
Advanced Configuration more about advanced configuration

📹 Videos

There have been some great review videos released by members of the community! Here are a few:

Neovim With AstroNvim | Your New Advanced Development Editor (Version: 3, Content By: @Cretezy)
Why I'm quitting VIM by Carlos Mafla (Version: 2, Content By: @gigo6000)
Astro Vim - All in one Nvim config!! by John McBride (Version: 1, Content By: @jpmcb)

🚀 Contributing

If you plan to contribute, please check the contribution guidelines first.

⭐ Credits

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

4gettt25 / astronvim Goto Github PK

astronvim's Introduction