Doom Emacs Documentation

Doom is a configuration framework for GNU Emacs 26.3+ tailored for Emacs bankruptcy veterans who want less framework in their frameworks and the performance of a hand rolled config (or better). It can be a foundation for your own config or a resource for Emacs enthusiasts to learn more about our favorite OS.

Doom is an opinionated collection of reasonable (and optional) defaults with a focus on performance (both runtime and startup) and on abstraction-light, readable code design, so that there is less between you and Emacs.

The documentation is designed to be viewed within Doom Emacs. Access it by pressing SPC h d h (or C-h d h for non-evil users), or search it with SPC h d s (or C-h d s).

Table of Contents

• Release Notes
• Documentation
  • Getting Started
  • Frequently Asked Questions
  • Contributing
  • Workflow Tips, Tricks & Tutorials
  • Module Appendix
• Community Resources
  • Asking for help
  • Project roadmap
  • Tutorials & guides
  • Projects that support/complement Doom
  • Similar projects

Release Notes

Documentation

Getting Started

• Install
• Update & Rollback
• Configure
• Migrate
• Troubleshoot

Frequently Asked Questions

• General
• Configuration
• Package Management
• Defaults
• Common Issues
• Contributing

Contributing

• Where to get help?
• Reporting issues
• Suggesting features, keybinds and enhancements
• Contributing code or documentation
• Other ways to support Doom Emacs
• Special thanks

Workflow Tips, Tricks & Tutorials

Module Appendix

Community Resources

Asking for help

• Our Discord server
• Our issue tracker

Project roadmap

• Development roadmap - A timeline outlining what’s being worked on and when it is expected to be done.
• Plugins under review - A sitrep on third party plugins that we’ve considered, rejected, or awaiting integration into Doom.
• Upstream bugs - Tracks issues originating from plugins and external programs that Doom relies on.

Tutorials & guides

• Doom Emacs
  • (videos) Doom Emacs Tutorials by DistroTube
  • (videos) DoomCasts by @zaiste
  • Noel’s crash course on Doom Emacs
  • Getting Started with Doom Emacs – a great transition from Vim to Emacs
  • The Niceties of evil in Doom Emacs
  • (video) Org-mode, literate programming in (Doom) Emacs
• Emacs & Emacs Lisp
  • The Official Emacs manual
  • A variety of Emacs resources - https://github.com/ema2159/awesome-emacs
  • Quick crash courses on Emacs Lisp’s syntax for programmers:
    • https://learnxinyminutes.com/docs/elisp/
    • http://steve-yegge.blogspot.com/2008/01/emergency-elisp.html
  • Workflows for customizing Emacs and its packages (and its C/C++ modes):
    • https://david.rothlis.net/emacs/customize_c.html
  • Tools in Emacs
    • How to use M-x calc
• Vim & Evil
  • A crash course on modal editing and Ex commands

Projects that support/complement Doom

• plexus/chemacs
• r-darwish/topgrade

Similar projects

• purcell/emacs.d
• seagle0128/.emacs.d
• syl20bnr/spacemacs