gitback/doomemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
aa1f11af4f
doomemacs/docs/index.org
Aku Kotkavuo dc745084d2 Fix documentation shortcut
2020-02-18 01:57:30 +02:00

5.0 KiB
Raw Blame History

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   TOC

TODO Release Notes

Documentation

Getting Started

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

Frequently Asked Questions

TODO Contributing

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

TODO Workflow Tips, Tricks & Tutorials

Module Appendix

Community Resources

Asking for help

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

Projects that support/compliment Doom

Similar projects