13 KiB

Raw Blame History

Doom Nvim

Features • Install • Documentation • Contribute

Introduction

Doom Nvim is a Neovim port of the doom-emacs framework and adapted to Vim philosophy.

Its goal is to give Neovim an initial configuration to start working in a stable and efficient development environment without spending a lot of time configuring everything and without forgetting that we don't all need the same environment.

As a vimmer, I know that it's difficult to configure Vim/Neovim when you are just starting to use it, how time consuming it's to customize it to your needs and that's why Doom Nvim exists also because I love Doom.

Its design is guided by these mantras:

Gotta go fast. Startup and run-time performance are priorities. That is why Doom Nvim uses Lua instead of Vimscript for its configurations and lazy-loads all the plugins.
Your system, your rules. You know better than a third party what is convenient for you. At least, Doom hopes so! It won't automatically install system dependencies nor plugins that have external dependencies (and will force plugins not to do so either if they have any external dependencies).
What does not serve you, you throw away. Doom Nvim is made up of a moderate number of plugins (~40 plugins as of this writing). You more than anyone know what you need in your environment and that's why Doom Nvim allows you to easily disable plugins and add new ones. Also, Doom Nvim doesn't come with TreeSitter parsers or Language Server Protocols configured by default, so you can use only what you need.

Notices

2021-07-12: If you are facing issues related to LuaSnip, update Doom Nvim and follow the instructions found in the issue #38.
2021-07-03: The doomrc has been fragmented and it is not working anymore, please see Migrating to 3.0.0 for more information.
2021-05-01: The doomrc is not using Vimscript anymore, please see the new doomrc file structure for use it with Lua.

Features

Minimalistic good looks inspired by modern code editors.
Works out of the box, just install and start editing.
A modular organizational structure for separating concerns in your config.
Extensible and customizable, everything can be easily modified.
Curated and sane defaults for many plugins.
Automatized, you don't have to care about manually managing plugins, installing language servers or even TreeSitter syntax parsers, Doom Nvim will handle all these things for you.
A declarative and powerful plugins management system (powered by packer.nvim).
Opt-in LSP integration for many languages by using the new built-in LSP included on Neovim 0.5.
An Emacs which-key like plugin to manage your keybindings, centered around leader prefix key (SPC).
Project search and more utilities, powered by telescope.nvim.

Prerequisites

Installation

Git 2.23+

Runtime

Neovim 0.5.0 onwards
GNU find
ripgrep 11.0+ or fd 7.3.0+ (optional but highly recommended, improves file indexing performance for some commands)
nodejs and npm (optional, required to use some Language Server Protocols)

Doom is comprised of ~40 optional plugins, some of which may have additional dependencies. Please visit their documentation.

Install

IMPORTANT: if you don't have a patched nerd font then you will need to install one in your system so you will be able to see icons in Neovim.

First you'll want to backup your current Neovim configuration if you have one.

NOTES:

Your current configuration will be backed up to ~/.config/nvim.bak or where your XDG_CONFIG_HOME environment variable points to.

If you're a cheovim user you can skip this step and go directly to installing with cheovim.

[ -d ${XDG_CONFIG_HOME:-$HOME/.config}/nvim ] && mv ${XDG_CONFIG_HOME:-$HOME/.config}/nvim ${XDG_CONFIG_HOME:-$HOME/.config}/nvim.bak

Now that you have backed up your current Neovim configuration you can proceed to install doom-nvim.

git clone --depth 1 https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/nvim

Or if you want to live in the bleeding-edge with the latest features:

git clone --depth 1 -b develop https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/nvim

Installing with cheovim

If you're using cheovim as your Neovim configurations manager you can install doom-nvim and then use the recipe listed in cheovim documentation:

# Clone doom-nvim under a specific directory under our '~/.config' directory
git clone --depth 1 https://github.com/NTBBloodbath/doom-nvim.git ${XDG_CONFIG_HOME:-$HOME/.config}/doom-nvim

# Change the doom-nvim internal path
sed -i "16s/nvim/doom-nvim/" ${XDG_CONFIG_HOME:-$HOME/.config}/doom-nvim/lua/doom/utils/init.lua

-- In your '~/.config/nvim/profiles.lua'
doom_nvim = { "~/.config/doom-nvim", {
        plugins = "packer",
        preconfigure = "doom-nvim"
    }
}

Then read our Getting Started guide to be walked through installing, configuring and maintaining Doom Nvim.

Getting help

Neovim is not very difficult. Although you will occasionally run into problems if you are not an advanced vimmer. When you do, here are some places you can look help:

Our documentation covers many use cases.
- The Configuration section covers how to configure Doom Nvim and its modules.
- The Plugins Management section covers how to install and disable plugins.
Our troubleshooting wiki
Search the Doom Nvim's issue tracker before opening a new issue to see if your issue was already been reported and to avoid duplicating issues.

Acknowledgements

hlissner per doing Doom Emacs ❤️.
romgrk per doing a port to Vim of Doom One colorscheme from Doom Emacs (and everyone who improves the colorscheme!).
All our contributors per helping improve Doom ❤️

Contribute

I really ❤️ pull requests and bug reports (please see the Contributing Guidelines before contributing)!
Don't hesitate to tell me my Lua coding style sucks, but please tell me why.

Contributors

Special thanks to these amazing people for helping improve doom (see emoji key):

_{John Irle} 📖	_{Brian Ketelsen} 💻 🐛	_Samantha-uk 📖	_rscircus 📖	_bandithedoge 📖	_vhyrro 💻	_{Ifeanyichukwu Sampson Ebenezer} 🐛
_{Gustavo Prieto} 💻	_ZeusThundr 🐛	_{Leo Nistor} 🐛	_notusknot 📖	_{Bruce Dillahunty} 📖 🐛	_amxj9 🐛	_{Kyle Guerrero} 📖