mirrors/doomemacs
1
Fork 0
mirror of https://github.com/doomemacs/doomemacs.git synced 2026-03-22 06:20:38 -07:00
Code Issues Projects Releases Wiki Activity
doomemacs/docs/index.org
xeruf 8afc54845f docs: update links in documentation and modules index 
some links were missing, outdated, or without description

tried to remedy that a bit,
pulling some information from behind the links to the overview

also small insertion for private config bisecting,
some sembr lines (better reading flow in editor)
and headline capitalisation improvements

index.org duplicates a lot of info from the README
and tends to lag behind, should consider options of merging -
from what I know github could support a README.org
that could also serve as index then,
or vice versa linking the markdown readme in emacs
2025-05-28 12:45:22 +02:00

5.3 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.
  • Packages 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/complement Doom

Similar Projects