![LunarVim Demo](./utils/media/lunarvim_logo_dark.png)

Latest release Last commit License Patreon donate button follow on Twitter

## Documentation You can find all of the documentation for Lunarvim at [lunarvim.org](https://www.lunarvim.org) ## Install In One Command! Make sure you have the release version of Neovim (0.5). ``` bash bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh) ``` ## Install Language support - Enter `:LspInstall` followed by `` to see your options for LSP - Enter `:TSInstall` followed by `` to see your options for syntax highlighting **NOTE** I recommend installing `lua` for autocomplete in `config.lua` ## Configuration file To activate other plugins and language features use the `lv-config.lua` file provided in the `nvim` folder (`~/.config/nvim/lv-config.lua`) in the master branch or (`~/.config/lvim/config.lua`) on rolling Example: ```lua -- general lvim.format_on_save = true lvim.colorscheme = "onedarker" lvim.leader = "space" -- add your own keymapping lvim.keys.normal_mode[""] = ":w" -- unmap a default keymapping -- lvim.keys.normal_mode[""] = "" -- edit a default keymapping -- lvim.keys.normal_mode[""] = ":q" -- set keymap with custom opts -- lvim.keys.insert_mode["po"] = {'', { noremap = true }} -- Use which-key to add extra bindings with the leader-key prefix -- lvim.builtin.which_key.mappings["P"] = { "Telescope projects", "Projects" } -- lvim.builtin.which_key.mappings["t"] = { -- name = "+Trouble", -- r = { "Trouble lsp_references", "References" }, -- f = { "Trouble lsp_definitions", "Definitions" }, -- d = { "Trouble lsp_document_diagnostics", "Diagnosticss" }, -- q = { "Trouble quickfix", "QuickFix" }, -- l = { "Trouble loclist", "LocationList" }, -- w = { "Trouble lsp_workspace_diagnostics", "Diagnosticss" }, -- } -- After changing plugin config exit and reopen LunarVim, Run :PackerInstall :PackerCompile lvim.builtin.dashboard.active = true lvim.builtin.terminal.active = true -- if you don't want all the parsers change this to a table of the ones you want lvim.builtin.treesitter.ensure_installed = "maintained" lvim.builtin.treesitter.ignore_install = { "haskell" } lvim.builtin.treesitter.highlight.enabled = true lvim.lsp.diagnostics.virtual_text = false -- set a formatter if you want to override the default lsp one (if it exists) lvim.lang.python.formatters = { { exe = "black", args = {} } } -- set an additional linter lvim.lang.python.linters = { { exe = "flake8", args = {} } } -- Additional Plugins lvim.plugins = { {"lunarvim/colorschemes"}, {"folke/tokyonight.nvim"}, { "ray-x/lsp_signature.nvim", config = function() require"lsp_signature".on_attach() end, event = "InsertEnter" } } -- Autocommands (https://neovim.io/doc/user/autocmd.html) -- lvim.autocommands.custom_groups = { -- { "BufWinEnter", "*.lua", "setlocal ts=8 sw=8" }, -- } ``` ## Updating LunarVim In order to update you should be aware of three things `Plugins`, `LunarVim` and `Neovim` To update plugins: ``` :PackerUpdate ``` To update LunarVim: ```bash cd ~/.local/share/lunarvim/lvim && git pull :PackerSync ``` ## Resources - [Documentation](https://www.lunarvim.org) - [YouTube](https://www.youtube.com/channel/UCS97tchJDq17Qms3cux8wcA) - [Discord](https://discord.gg/Xb9B4Ny) - [Twitter](https://twitter.com/chrisatmachine) ## Testimonials > "I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly." > - @juanCortelezzi, LunarVim user. > "My minimal config with a good amount less code than LunarVim loads 40ms slower. Time to switch." > - @mvllow, Potential LunarVim user.
[![Lua](https://img.shields.io/badge/Made%20with%20Lua-blue.svg?style=for-the-badge&logo=lua)](#madewithlua)