My favorite VIM based IDE !!

kylo252 a273c46eee feat: add LvimUpdate command (#1634) 3 years ago
.github e270bdbd6f [Bugfix]: Use local install in Github actions (#1628) 3 years ago
colors 0f458a0468 onedarker colorscheme 3 years ago
ftdetect 9ec39484eb [Feature]: add basic `JSONC` support (#1535) 3 years ago
ftplugin 5cdd742354 fix not being able to add linters and formatters to docker (#1486) 3 years ago
lua a273c46eee feat: add LvimUpdate command (#1634) 3 years ago
tests 8eed75d67f refactor: use more flexible paths (#1381) 3 years ago
utils a273c46eee feat: add LvimUpdate command (#1634) 3 years ago
.gitignore a6cf2e871a stylua is always in root 4 years ago
.luacheckrc 254ab2102b [Feature] Add lunarvim latest release tag to dashboard (#1436) 3 years ago
.pre-commit-config.yaml 346925fcdc feat: add commitlint CI (#1459) 3 years ago
.stylua.toml a6cf2e871a stylua is always in root 4 years ago
CONTRIBUTING.md 346925fcdc feat: add commitlint CI (#1459) 3 years ago
LICENSE d3e94f3086 update license 4 years ago
Makefile 38f53bf08c [Feature]: Add some very basic unit-tests (#1369) 3 years ago
README.md a273c46eee feat: add LvimUpdate command (#1634) 3 years ago
init.lua 8eed75d67f refactor: use more flexible paths (#1381) 3 years ago

README.md

LunarVim Demo

Documentation

You can find all the documentation for Lunarvim at lunarvim.org

Install In One Command!

Make sure you have the release version of Neovim (0.5).

bash <(curl -s https://raw.githubusercontent.com/lunarvim/lunarvim/master/utils/installer/install.sh)

Install Language support

  • Enter :LspInstall followed by <TAB> to see your options for LSP

  • Enter :TSInstall followed by <TAB> to see your options for syntax highlighting

NOTE I recommend installing lua for autocomplete in config.lua

Demo1 Demo2 Demo3

Configuration file

To install plugins configure LunarVim use the config.lua located here: ~/.config/lvim/config.lua

Example:

-- general
lvim.format_on_save = true
lvim.colorscheme = "onedarker"

lvim.leader = "space"
-- add your own keymapping
lvim.keys.normal_mode["<C-s>"] = ":w<cr>"
-- unmap a default keymapping
-- lvim.keys.normal_mode["<C-Up>"] = ""
-- edit a default keymapping
-- lvim.keys.normal_mode["<C-q>"] = ":q<cr>"
-- set keymap with custom opts
-- lvim.keys.insert_mode["po"] = {'<ESC>', { noremap = true }}

-- Use which-key to add extra bindings with the leader-key prefix
-- lvim.builtin.which_key.mappings["P"] = { "<cmd>Telescope projects<CR>", "Projects" }

-- Configure builtin plugins
lvim.builtin.dashboard.active = true
lvim.builtin.terminal.active = true

-- Treesitter parsers change this to a table of the languages you want i.e. {"java", "python", javascript}
lvim.builtin.treesitter.ensure_installed = "maintained"
lvim.builtin.treesitter.ignore_install = { "haskell" }

-- Disable virtual text
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 = "BufRead"
    }
}

Updating LunarVim

  • inside LunarVim :LvimUpdate
  • from the command-line lvim +LvimUpdate +q

Update the plugins

  • inside LunarVim :PackerUpdate

Resources

Testimonials

"I have the processing power of a potato with 4 gb of ram and LunarVim runs perfectly."

"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)