Welcome to doom-evim

This project has been inspired by doom-emacs and doom-nvim. However, I named it doom because it is batteries-included like doom-nvim and doom-emacs. Why the 'e'? To pay a homage to emacs' revered emacs-lisp.

I also provide a big thanks to doom-nvim because I have stolen some of their stuff to configure mine. You can visit it here: doom-nvim

Introduction

If you have used doom-emacs or doom-nvim before, you will be acquianted with what a 'distribution' means. This contains OPINIONATED configuration of my own that works out of the box.

It is certainly not entirely complete but since doom is a distro, it comes with sane defaults that can aid in quickly bolting on required configurations.

Features

1. Fennel support for those who really miss elisp!
2. Preconfigured Debugger Adapter Protocol (DAP) and Language Server Protocol (LSP) via vimspector and nvim-lsp.
3. Minimal abstraction provided by doom which facilitates easy configuration.
4. Default keybindings which similar to doom-emacs.
5. Wide array of utility functions available to the user for complex configuration: after!, specs!, add-hook, define-keys, etc
6. Which-key and snippets work out of the box.
7. Comprehensive inbuilt documentation accessible via :help.
8. Easy snippet creation.
9. Nice basic REPL.

Installation

Getting the configuration

You can either clone the repo and use ruby doom.rb set-version to select a version of doom. If you don't do that, you will be using the latest commits which may or may not be stable. Alternatively, you can download a release and extract it as ~/.config/nvim.

Basic requirements

1. neovim >= 0.5.
2. fdfind, lua5.1, luarocks, rg, ruby, node and npm. You OS package manager should have these. After you install these, please install yarn via npm.
3. GNU/Linux. Currently doom-evim only supports GNU/Linux.

How to install other requirements?

Assuming that you have all of the above tasks done, you can use doom.rb to provide a basic utility script to do other tasks that may confuse the user. Please visit here: doom.rb

How to update?

Do not run git pull because this can lead to pulling of unfinished features which can lead to unexpected bugs. Please download the latest (main version) release instead. Please use ruby doom.rb set-version instead.

Downgrading?

Downgrading between main doom-evim versions is recommended, for eg. v1.x.x, v2.x.x are main versions. You can use ruby doom.rb set-version to do this.

Keybindings

Here.

Screenshots

Here.

Further reading

I highly recommend you to go through doom's in-built documentation :help doom-evim

Future plans

1. Add support to a variety of languages
2. Get nvim-dap up and working. Vimspector works for the languages it provides adapters for.

Bugs

Currently, doom does not contain any breaking bugs. However, if you happen to find one or have any other questions, please feel free to open an issue or start a discussion.

Maintaining

I plan to make this a nice stable distribution. However, I need help maintaining this. Any volunteers are welcome here anytime!