lunarvim / lunarvim.org

🌐 Website for LunarVim

An IDE layer for Neovim with sane defaults. Completely free and community driven.

---

 
 Install 
    
 Configure 
    
 Troubleshooting 
    
 Contribute 
 

---

Showcase

Socials

Thanks to all contributors

lunarvim.org's Issues

Add more verbose troubleshooting and prerequisite paragraph

Releated issue on LunarVim:
LunarVim/LunarVim#1528

Adds a prerequisites paragraph so some troubleshooting can be avoided

Adds a more verbose paragraph on troubleshooting so that it is easier for a more casual user to troubleshoot his/her installation

Change tabnine-compe to tabnine-cmp

This is used currently:

Since LunarVim is using cmp engine now, the instructions should use https://github.com/tzachar/cmp-tabnine

Remove fade on dark mode

The fade between dark mode and light mode looks quite good, however it makes it very jarring when you actually use the website. The website will always start out in light mode, and then transition to dark mode (if you use dark mode). So you will always be faced with a bright light page every time you open the website.

So even though the fade does look good, I don't think its worth it. People generally only choose their theme of choice once and leave it there. So the fade really only serves a purpose the few times you change the theme, while the jarring white transition will occur every time.

I am not quite sure that removing the transition will completely remove this side effect, the website might still flash white (during a shorter duration), but it might be worth it anyways since its quite easy to do.

The other (better way) of fixing this issue is to check if dark mode is activated before rendering the page, and then render it as dark mode from the beginning. Then you can use the transition only when the dark mode is changed with the button. Of course this is harder to implement but it might be worth it.

[HACKTOBERFEST] add links to different lanuage setups to home page

^^ like this

[hacktoberfest] embed youtube video/videos/playlist to docs where appropriate

Provide more essential documentation on how to navigate LunarVim on quickstart page

Currently, navigating certain key components of LunarVim's interface require familiarity with external plugins. This by itself is not a problem, the problem is that there isn't an easy way for a new user to find out what some of those plugins are, and thus read their documentation, leading to an artificially steep learning curve early on.

This thread summarizes this issue: a new user has no clue how to use the default file explorer bundled with LunarVim because they're unfamiliar with the plugin it is based on. There's nothing to indicate the explorer on the screen is nvim-tree, and although there's a simple keybinding to list other keybindings, it's not shown anywhere.

As @rebuilt mentioned in the thread, it's unreasonable to expect this project's website to host the documentation for each and every core plugin, as these plugins are updated all the time. I think a good compromise for an IDE however, would be to describe the default UI components used for navigation and link to their respective documentation pages directly on the quickstart page.

​[Hacktoberfest] add some CI for typos in the docs repo

see title

Dependency for Telescope: fd

Feature Description

I had some problem using the “find file” function in Windows on the start page. After the Installation of fd in Windows the function worked.
-> fd should be listed under the Windows dependencies

I don't got the information anymore to make a valid bug report so I put it in here.

Thank you in advance.

Describe the alternatives you have considered

No response

Support information

No response

mirror.ghproxy.com has been shutdown in Mainland China

ghproxy shows that mirror.ghproxy.com has been shutdown in Mainland China. I think we should delete it in Installation

Include an explanation of what LunarVim is on the website and docs

Feature Description

Currently neither the website nor the docs explain what LunarVim is. I ended up having to look at the readme to see:

An IDE layer for Neovim with sane defaults. Completely free and community driven.

For newcomers, that's a lot of clicking to find out what they're actually looking at.

Describe the alternatives you have considered

No response

Support information

No response

Translation problems

I saw Chinese from source, but why almost no Chinese website

Add documentation on how to add custom luasnip snippet files.

Would it be possible to append a small amount of documentation on the heading path Plugins/Default Plugins/Snippets/LuaSnip
on how to add custom snippet files within the configuration file and where to store these snippet files?

dial config is outdated

Dial plugin no longer has an entry point on require"dial". Now you have to require either dial.config or dial. augend.
I don't have enough knowledge of the plugin to fix it myself

Docs for configuring Lunarvim for Ansible

Is it possible to add instruction for Ansible to the Languages section of the docs?

Docs not clear on how to install formatters and linters

Hey great work on lunar vim!

In the lunarvim.org/docs/languages/typescript.md it just says

The configured formatter(s) must be installed separately. and The configured linter must be installed separately.

I feel it would be really helpful for those new to lunarvim if the docs were updated with instructions on how to install the formatter and linter

the same for the other language docs too(eg.lunarvim.org/docs/languages/javascript.md) and the main readme.md(lunarvim.org/docs/languages/README.md)

[hacktoberfest] embed youtube video/videos/playlist on homepage

copy to clipboard button inside code block doesn't work

nothing happens when clicking on the button

Browser: Firefox 100.0.2 (64-bit)

Confusing image at landing page

Feature Description

You have confusing image at landing page

There are opened Search.js and Header.js that using JSX react syntaxt. But the file extension is js - that seems strange (but possible)

Describe the alternatives you have considered

Change Search.js and Header.js (and other components in explorer) to Search.jsx and Header.jsx

Support information

No response

Debugger setting for Rust is broken; alternative found

Debugging section of the Rust page says to run

:DIInstall ccppr_lldb

but dap-installer does not implement installing ccppr_lldb (see pocco81/dap-buddy.nvim#50). Is this just temporarily broken or was this a temporary placeholder? If it's a placeholder, I figured out how to add debug support (with pretty-printing!):

1. Run :DIInstall codelldb first

2. Add the following to ftplugin/rust.lua:

Edit: actually no, see the next comment

(This code is no longer relevant)

```lua local dap_install = require "dap-install" dap_install.config("codelldb", { -- adapter code taken from https://github.com/mfussenegger/nvim-dap/wiki/C-C---Rust-(via--codelldb) adapters = function(on_adapter) local stdout = vim.loop.new_pipe(false) local stderr = vim.loop.new_pipe(false) local cmd = require("dap-install.config.settings").options["installation_path"] .. "codelldb/extension/adapter/codelldb" local handle, pid_or_err local opts = { stdio = {nil, stdout, stderr}, detached = true, } handle, pid_or_err = vim.loop.spawn(cmd, opts, function(code) stdout:close() stderr:close() handle:close() if code ~= 0 then print("codelldb exited with code", code) end end) assert(handle, "Error running codelldb: " .. tostring(pid_or_err)) stdout:read_start(function(err, chunk) assert(not err, err) if chunk then local port = chunk:match('Listening on port (%d+)') if port then vim.schedule(function() on_adapter({ type = 'server', host = '127.0.0.1', port = port }) end) else vim.schedule(function() require("dap.repl").append(chunk) end) end end end) stderr:read_start(function(err, chunk) assert(not err, err) if chunk then vim.schedule(function() require("dap.repl").append(chunk) end) end end) end, configurations = { { type = "codelldb", request = "launch", name = "Launch Rust", program = function() return vim.fn.input('Path to build (w. symbols): ', vim.fn.getcwd() .. '/target/debug/', 'file') end, cwd = "${workspaceFolder}", stopOnEntry = false, }, } }) ```

My main focus was to find a solution that has pretty-printing, and while ccppr_vsc did work, there was no pretty-printing.

fix: update glow installation

Recent changes to the glow project require to call the setup function.

The following installation works:

{
    "ellisonleao/glow.nvim",
    config = function()
        require("glow").setup()
    end,
    -- run = "yay -S glow"
},

The docs show 3 instances where the installation instructions happen, should those 3 be updated? Wanted to do a PR for this change but I don't know how to approach.

Do you still accept document translations?

Feature Description

There is already a Chinese document, but it still not perfect.
I'm busy recently, if possible, I will pr documents before July.

Describe the alternatives you have considered

No response

Support information

No response

Chinese translation

Working on the Chinese translation of this website.

Conjure (Clojure and lisp) plugin keybindings

Hi
Congrats in LunarVim, it looks and feel awesome :)

Im trying to setup/use LunarVim with Clojure. Im using 'Conjure' NeoVim plugin. Ive managed to 'load' it but where do I assign the keybindings and commands like ConjureConnect, ConjureEval etc ?

Add documentation for setting up Angular LSP

indent-blankline wrong settings

Problem description

Please, update on the docs setting tabs for this plugin
The next settings is true (without it we have broken start screen)

{
"lukas-reineke/indent-blankline.nvim",
event = "BufRead",
setup = function()
vim.g.indentLine_enabled = 1
vim.g.indent_blankline_char = "‚ñè"
vim.g.indent_blankline_filetype_exclude = { "help", "terminal", "dashboard", "lspinfo" }
vim.g.indent_blankline_buftype_exclude = { "terminal", "dashboard", "nofile", "quickfix" }
vim.g.indent_blankline_show_trailing_blankline_indent = false
vim.g.indent_blankline_show_first_indent_level = false
vim.g.indent_blankline_show_current_context = true
vim.g.indent_blankline_show_current_context_start = true
end
},

LunarVim version

last

Neovim version (>= 0.7)

7

Operating system/version

Any

Steps to reproduce

No response

support info

:)

Screenshots

No response

slim down sidebar

Zoom between 133% and 200% and the sidebar expands to almost 50% of the page. The content itself seems cramped on my 13.3" screen.

Every section rendered twice

Hello,

When I visit https://www.lunarvim.org/ the sections on every page are repeated twice.
I use Chrome and Edge.

Not sure if it's related but there is also a console error
Hydration completed but contains mismatches.

Below is an example from the installation page.

The windows url in the lunarvim is not updated to version 1.2. it is still version rolling-7d57046

Problem description

1. https://www.lunarvim.org/docs/installation
2. then copy the url for windows
   and check the version, is still rolling release

LunarVim version

version rolling-7d57046

Neovim version (>= 0.8.0)

NVIM v0.8.0-1210-gd367ed9b2

Operating system/version

windows 11

Steps to reproduce

No response

support info

LSPInfo:
Language client log: C:\Users\andres.parra\AppData\Local\nvim-data\lsp.log
Detected filetype: alpha

0 client(s) attached to this buffer:

Configured servers list: csharp_ls

Lspinfo:
Buffer info

• filetype: alpha
• bufnr: 1
• treesitter status: inactive

Active client(s)

Automatic LSP info

• Skipped servers: [angularls, ansiblels, csharp_ls, cssmodules_ls, denols, ember, emmet_ls, eslint, golangci_lint_ls, gradle_ls, graphql, jedi_language_server, ltex, phpactor, psalm, pylsp, quick_lint_js, reason_ls, rome, ruby_ls, solang, solc, sorbet, sourcery, sqlls, sqls, stylelint_lsp, svlangserver, tflint, verible, vuels, csharp_ls]

Formatters info

• Active:
• Supported: []

Linters info

• Active:
• Supported: []

Code actions info

• Active:

Screenshots

No response

New docs layout

Plan for a new layout:

# Installation
  - [new] Post install ($PATH, nerd fonts)
# Beginner's guide
  - [new] Terminology (what's LSP, treesitter, autocmds)
  - [new] Plugins overview (most important ones)
  - Keybinds overview  
# Configuration
  - [new] Options (vim.opt, vim.g)
  - Keybindings
  - Plugins
    - [new] Core plugins (lvim.builtin)
    - [new] User plugins (lvim.plugins)
    - Example configurations (current `plugins/extra-plugins.md`)
  - Appearance (no readme.md)
    - Colorschemes
    - Statusline
  - LSP (current `languages/README.md`) TODO: better name for the section
  - Snippets
  - Autocommands
  - Ftplugin
# [new/needs update] FAQ
# Troubleshooting
# Features
  - Supported languages (current languages)
    - ...
  - Supported frameworks (current frameworks)
    - ...
# community
  - Meet the team

todo list

• Post install (#353)
• Terminology
• Plugins overview
• Options (vim.opt, vim.g)
• Core plugins (lvim.builtin)
• User plugins (lvim.plugins)
• Appearance
• LSP
• FAQ

fixes #217, #251

Can't find the search in the new website

I can't find the search input field in the website

is this in purpose?

docs/troubleshooting: Installing `tree-sitter-cli` fails with `node 18`

I am trying to install LunarVim on Ubuntu 20.04. I made sure I had all the prerequisites installed, including node and npm, installed via nvm, as to avoid an EACCES error.

However with node at the latest LTS (v18.12.1 -> Hydrogen), installing tree-sitter-cli fails with:

npm ERR! code 1
npm ERR! path /home/maria/.nvm/versions/node/v18.12.1/lib/node_modules/tree-sitter-cli
npm ERR! command failed
npm ERR! command sh -c -- node install.js
npm ERR! Downloading https://github.com/tree-sitter/tree-sitter/releases/download/v0.20.7/tree-sitter-linux-x64.gz
npm ERR! node:events:491
npm ERR!       throw er; // Unhandled 'error' event
npm ERR!       ^
npm ERR! 
npm ERR! Error: connect ETIMEDOUT 64:ff9b::8c52:7903:443
npm ERR!     at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1300:16)
npm ERR! Emitted 'error' event on ClientRequest instance at:
npm ERR!     at TLSSocket.socketErrorListener (node:_http_client:494:9)
npm ERR!     at TLSSocket.emit (node:events:513:28)
npm ERR!     at emitErrorNT (node:internal/streams/destroy:151:8)
npm ERR!     at emitErrorCloseNT (node:internal/streams/destroy:116:3)
npm ERR!     at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
npm ERR!   errno: -110,
npm ERR!   code: 'ETIMEDOUT',
npm ERR!   syscall: 'connect',
npm ERR!   address: '64:ff9b::8c52:7903',
npm ERR!   port: 443
npm ERR! }
npm ERR! 
npm ERR! Node.js v18.12.1

After browsing the net I've come to the conclusion that it's something related to the IPv6 usage. I downgraded to node 16 (without disabling IPv6 on my machine) and the installation process was finally successful.

It might be a good idea to include these steps in the troubleshooting section, or at least a hint, as it actually saves the user from a lot of trouble 😉 . It is not a LunarVim issue, however it improves user experience (I was this close 👌 to give up and not try LunarVim at all).

Overview of keymaps/keybindings

Feature Description

I think in the documentation (website and/or README) should be a, for example, a mindmap for all the keymaps of Lunarvim. I know that you can press space to show the commands but it will be helpfull to have an overview. Also for beginners. 🙂

Describe the alternatives you have considered

No response

Support information

No response

Portuguese translation

I can translate all the documentation to Portuguese and maintain it, I have free time to do it, I just need to know if u guys want it

Is the spanish translation a good idea?

I can translate all the documentation to spanish and maintain it (something like one day per week) but, it is a good idea?
Thanks!

navbar icons changing to boxes when scrolling down

2022-10-03.22-10-35.mp4

happens in chrome and edge on windows

Documentation for working with the explorer

Feature Description

Just like pressing the space key and seeing what keys I can press to do certain actions in the editor, I want to do the same in the explorer. I've been trying to create a folder for 15 minutes.

Describe the alternatives you have considered

Pressing all the keys to see which one does what 😭

Support information

No response

Example configuration of neoscroll should disable lazy loading

I noticed an annoying little difference between 1.2 and 1.3 which I tracked down to the change from Packer to Lazy. The neoscroll plugin wouldn't work until the second time I triggered it. The difference in behavior is a little jarring, so I'd like to suggest changing the example configuration to disable lazy loading for that specific plugin in version 1.3's documentation.

If that sounds good to you all, I'd be happy submit a pull request.

Adding a troubleshooting tab

I think we should add a tab to the website for common problems people encounter, like fonts not showing up, getting permission errors when installing lunarvim etc

Add version switcher

It would be great to be able to switch between different releases and nightly version of the docs. Then users could choose the version that matches lvim installed on their machine

docusaurus: use metadata instead of number prefixes

number prefixes make it hard to add/move/remove documents, metadata is a more flexible approach and we're already using it for categories, my main reason for doing it is the warning under the number prefixes docs linked above, I want to add a beginner's guide and it would require moving around some documents and all the links with numbers would need to be changed

What do you think?

Docs: Manual Install

Feature Description

I would like to see new documentation for installing LunarVim without using the installer script. I am attempting to install LunarVim unattended via Ansible and though I have passed in the --yes flag, there is still some kind of error around Preparing Packer Setup. Having documentation for installing manually will help non-interactive installs and be useful for debugging.

Describe the alternatives you have considered

No response

Support information

No response

need a git section on docs

Feature Description

I installed LunarVim on my Linux and I saw a shortcut to open <leader> g g for LazyGit, but it wasn't working.
Problem is LunarVim not installing it automatically, and it's also not mentioned to install LazyGit manually by ourselves anywhere on the docs. As a beginner, I'm was confused about this issue. Could we have a Git section on the documentation covering these types of issues with Git?

Describe the alternatives you have considered

No response

Support information

No response

"Search" does not appear to index all pages

refrencing this comment on the main repo.

Search does not appear to index all pages, particularly the Core Plugins page. Searching for "tree-nvim", returns only "nvim-treesitter-context", which is in Extra Plugins:

When searching "file", "explorer", no results are shown.

Document how to debug with dap using lunarvim

When trying out starter.lvim confs I found the debugger weren't working for several of them.

The issue was that I had to install the dap packages through :Mason, however there was no clear way for me to know this or which dap package I should install (for example, for go-ide you're to install delve rather than go-debug-adapter as one might guess based on the name alone)

I think it'd be very helpful to have a page to show how to use dap with lunarvim and furthermore a debug section for each language that says which dap package you should install for that language

about the translation work

I'd like to help translate the documentation, but where and how should I start? I'd also like to know if there's anything I should be aware of when translating.

Rust deprecated options

For Rust lang settings the option

 hover_with_actions = true

is deprecated, so update it to next

 -- options same as lsp hover / vim.lsp.util.open_floating_preview()
    hover_actions = {

      -- the border that is used for the hover window
      -- see vim.api.nvim_open_win()
      border = {
        { "╭", "FloatBorder" },
        { "─", "FloatBorder" },
        { "╮", "FloatBorder" },
        { "│", "FloatBorder" },
        { "╯", "FloatBorder" },
        { "─", "FloatBorder" },
        { "╰", "FloatBorder" },
        { "│", "FloatBorder" },
      },

      -- whether the hover action window gets automatically focused
      -- default: false
      auto_focus = false,
    },

https://github.com/simrat39/rust-tools.nvim

Better document extension points

Feature Description

Hello, first, thanks for this wonderful neovim preset. It looks outstanding and really lowers the entry barrier.
However, when it's time to extend and customise it beyond the most basic (keymaps and just adding more basic plugins) it is not easy to understand. For example, each plugin documentation has it's own set of assumptions about how is your environment and the knowledge you have about it (basically your personal configuration), but in the case of lunar most people will have no idea if they can just follow the plugin instructions or they have to hook that into some lunar vim startup function.
I will list the things that I think are worth documenting, but probably there are more

Describe the alternatives you have considered

Right now the only alternative is reading the source-code, but that is not very comfortable because you have to navigate the repository, have a good understanding of lua and a good understanding of neovim apis and vim in general. Those are too high of a entry barrier.

Support information

Some of the things I think are worth documenting are:

• Startup order: what files are loaded first? When does the user config kick in?
• What is available at certain point? For example, can I require a plugin inside the config after the declaration of plugins? Or should I defer it to a
• Available setup-hooks/callback. For example, there is lvim.builtin.telescope.on_config_done that is called once the telescope config is complete and you can use that to add telescope extensions. I think there is the same callback available for other plugins, so it will be awesome to document that
• How to extend specific plugin configurations? The number of built-in plugins is very nice, and sometimes you just want to change one little detail, but how to do this is not clear. Should I override the entire plugin configuration? Can I just "extend" it? Is there any user entrypoint that will get merged with the defaults?

White-flash when using dark mode

When the dark mode is enabled, the page flashes, when initially loaded or refreshed.

Where to document how to configure CMP floating window?

Hello. After some frustration I discovered that, to configure the height of the cmp window height you have to set the vim configuration vim.opt.pumheight. This was a bit surprising despite I have been using lunarvim for some time, and I decided it will be a good idea to document it to make it more obvious for newcomers. However, I can't find a proper section under the docs. There is no "extra information" or "how to configure" for specific built in plugins.
Any recomendation?

need to update document about DAP

I'm using neovim 0.7.0, when install debugger following the steps in: https://www.lunarvim.org/languages/go.html#lsp-settings

:DIInstall go_delve

There reported "Not an editor command: DIInstall"
Then I added

lvim.builtin.dap.active = true

in ~/.config/lvim/config.lua.
and DAPInstall and nvim-dap plugins are installed, however there still report "Not an editor command: DIInstall"

Very frustrating.