11# Doom Nvim Documentation
22
3- Doom Nvim is a port to Neovim of the [ Doom Emacs] ( https://github.com/hlissner/doom-emacs )
4- configuration framework for [ GNU Emacs] ( https://www.gnu.org/software/emacs/ ) adapted
5- for all vimmer who want less framework in their framework and the performance of
6- a handmade configuration (or better). It can be a base for your own setup or a
7- resource for Neovim enthusiasts to learn more about our favorite editor and how to
8- do X things on it by using Lua.
9-
10- Doom Nvim is an opinionated collection of reasonable (and optional) defaults with
11- a focus on performance (both runtime and startup) and on abstraction-light, readable
12- code design, so that there is less between you and Neovim.
13-
143> The documentation is designed to be viewed within Doom Nvim. Access it by pressing
154> ` :h doom_nvim ` .
165
176## Documentation
187
19- ### Getting Started
20-
21- - [ Install] ( ./getting_started.md#install )
22- - [ Update & Rollback] ( ./getting_started.md#update--rollback )
23- - [ Configuration] ( ./getting_started.md#configuration )
24-
25- ### Modules
26-
27- - [ Introduction] ( ./modules.md#introduction )
28- - [ Tweaking Doom Nvim Modules] ( ./modules.md#tweaking-doom-nvim-modules )
8+ - [ All Modules] ( ./modules.md#all-modules )
9+ - [ Configuring modules] ( ./modules.md#quick-guide )
10+ - [ Buidling/contributing your own modules] ( ./modules.md#building-your-own-module )
11+ - [ API Reference] ( ./api.md ) :warning : Not yet implemented. Refer to comments in [ doom_global.lua] ( ../lua/doom/core/doom_global.lua )
2912
3013### Contributing
3114
32- - [ Where can I help?] ( ./contributing.md#where-can-i-help )
3315- [ Reporting issues] ( ./contributing.md#reporting-issues )
3416- [ Suggesting features, keybinds and enhancements] ( ./contributing.md#suggesting-features-keybinds-and-enhancements )
3517- [ Contributing code] ( ./contributing.md#contributing-code )
@@ -39,7 +21,3 @@ code design, so that there is less between you and Neovim.
3921### Asking for help
4022
4123- [ Our issues tracker] ( https://github.com/NTBBloodbath/doom-nvim/issues )
42-
43- ### Projects
44-
45- - [ Projects] ( https://github.com/NTBBloodbath/doom-nvim/projects )
0 commit comments