core - An Emacs framework for the stubborn martian hacker

项目说明

> [!CAUTION]
> doomemacs.com is not associated with nor endorsed by this project!
> doomemacs.org is our one and only domain. Read our announcement about it
> here.

-----

<di="center">

Doom Emacs

Install • [Documentation] • [FAQ] • [Screenshots] • Contribute

!Made with Doom Emacs
!Supports Emacs 27.1–31.1
!Latest commit
<!-- !Build status: master -->
![Discord Server][discord]
![Github Discussions][discuss]

!Doom Emacs Screenshot

</div>

---

Table of Contents

Introduction

Features

Prerequisites

Install

Roadmap

Getting help

Contribute

Introduction

<a href="
<img src=" align="right" />
</a>

> It is a story as old as time. A stubborn, shell-dwelling, and melodramatic
> —envious of the features of modern text editors—spirals into
> despair before he succumbs to the [dark side][e]. This is his config.

Doom is a configuration 框架 for [GNU Emacs] tailored for Emacs bankruptcy
who want less 框架 in their frameworks, a modicum of stability
(and reproducibility) from their package manager, 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 fa operating
system.

Its design is guided by these mantras:

+ Gotta go fast. Startup and run-time performance are priorities. Doom goes
beyond by modifying packages to be snappier and load lazier.
+ Close to metal. There's less between you and Emacs by design.
That's less to grok and less to work around when you tinker. Internals ought
to be written as if reading them were part of Doom's UX, and it is!
+ Opinionated, but not stubborn. Doom is about reasonable defaults and
curated opinions, but use as little or as much of it as you like.
+ Your system, your rules. You know better. At least, Doom hopes so! It
won't *automatically* install system dependencies (and will force plugins not
to either). Rely on doom doctor to tell you what's missing.
+ Nix/Guix is a great idea! The Emacs ecosystem is temperamental. Things
break and they break often. Disaster recovery should be a priority! Doom's
package management should be declarative and your private config reproducible,
and comes with a means to roll back releases and updates (still a WIP).

Check out [the FAQ][FAQ] for answers to common questions about the project.

Features

Minimalistic good looks inspired by modern editors.

Curated and sane defaults for many packages, (major) OSes, and Emacs itself.

A modular organizational structure for separating concerns in your config.

A standard library designed to simplify your elisp bike shedding.

A declarati management system][package-management] (powered by

[straight.el]) with a command line interface. Install packages from anywhere,
not just (M)ELPA, and pin them to any commit.

Optional powered by [e], including ports of popular vim

plugins like [], [], [] and
[more][ported-]!

Opt-in LSP integration for many languages, using [lsp-mode] or [eglot]

Support for *many* programming languages. Includes syntax highlighting,

linters/checker integration, inline 代码 e, 代码 completion (where
possible), REPLs, documentation lookups, snippets, and more!

Support for *many* tools, like docker, pass, ansible, terraform, and more.

A Spacemacs-esque [keybinding scheme][bindings], centered around leader

and localleader prefix keys (<kbd>SPC</kbd> and <kbd>SPC</kbd><kbd>m</kbd> for
e, <kbd>C-c</kbd> and <kbd>C-c l</kbd> for users).

A rule-based [popup manager][popup-system] to control how temporary buffers

are displayed (and disposed of).

Per-file indentation style detection and [editorconfig] integration. Let

someone else argue about tabs vs _spaces_.

Project-management tools and 框架-specific minor modes with their own

snippets libraries.

Project search (and replace) utilities, powered by [ripgrep] and [ivy] or

[helm].

Isolated and persistent workspaces (also substitutes for vim tabs).

Support for Chinese and Japanese input systems.

Save a snapshot of your shell en to a file for Emacs to load at

startup. No more struggling to get Emacs to inherit your PATH, among other
things.

Prerequisites

Required:

- GNU Emacs 27.1–31.1 (31.1 is recommended)
- Using only Doom's CLI requires 27.1+
- Using Doom as a starter kit requires 29.1+
- Git >= 2.23
- [ripgrep] >= 11.0

Optional, but recommended:

- [fd] 7.3.0+ (used to improve file indexing performance)
- GNU of find, ls, and tar (on MacOS and BSD *nix)
- Symbola font (Emacs' fallback font for glyphs it can't display)

> [!WARNING]
> Avoid unstable and pre-release builds of Emacs. These end in .50, .60,
> or .9X (e.g. 28.1.91). Doom should generally work on Emacs HEAD (the
> maintainer dogfoods it), but support lags behind the bleeding edge by at least
> a month or so.

> [!IMPORTANT]
> Doom is comprised of [~150 optional modules][Modules], some of which may have
> additional dependencies. [Visit their documentation][Modules] or run bin/doom
> doctor to check for any that you may ha.

Install

Then [read our Getting Started guide][getting-started] to be walked through
installing, configuring and maintaining Doom Emacs.

It's a good idea to add ~/.config/emacs/bin to your PATH! Other bin/doom
commands you should know about:

+ doom sync to synchronize your private config with Doom by installing missing
packages, removing orphaned packages, and regenerating caches. Run this
whenever you modify your private init.el or packages.el, or install/remove
an Emacs package through your OS package manager (e.g. mu4e or agda).
+ doom sync --env to include a snapshot of your shell en that Doom
will load at startup. This allows Emacs to inherit your PATH, among other
things. This replaces
exec-path-from-shell.
+ doom upgrade to update Doom to the latest release & all installed packages.
+ doom doctor to diagnose common issues with your system and config.

Roadmap

Doom is an active and ongoing project. To make that de more
transparent, its roadmap (and other concerns) are published across three github
project boards and a newsletter:

De Roadmap

Packages under review:

lists plugins we are watching and considering for inclusion, and what their
status for inclusion is. Please consult this list before requesting new
packages/features.
+ Upstream bugs: lists
issues that originate from elsewhere, and whether or not we ha
workarounds or temporary fixes for them.
+ ~~Doom's newsletter~~ (not finished) will contain changelogs in between
releases.

Getting help

Emacs is no journey of a mere thousand miles. You _will_ run into problems and
mysterious errors. When you do, here are some places you can look for help:

+ [Our documentation][documentation] covers many use cases.
+ [The Configuration section][configuration] covers how to configure Doom and
its packages.
+ [The Package Management section][package-management] covers how to install
and disable packages.
+ [This section][bin/doom] explains the bin/doom script's most important
commands.
+ [This section][common-mistakes] lists some common configuration mistakes new
users make, when migrating a config from another distro or their own.
+ [This answer][change-theme] shows you how to add your own themes to your
private config.
+ [This answer][change-font] shows you how to change the default font.
+ Your issue may be documented in the [FAQ].
+ With Emacs built-in help system documentation is a keystroke away:
+ For functions: <kbd>SPC h f</kbd> or <kbd>C-h f</kbd>
+ For : <kbd>SPC h v</kbd> or <kbd>C-h v</kbd>
+ For a keybind: <kbd>SPC h k</kbd> or <kbd>C-h k</kbd>
+ To search a keybinds: <kbd>SPC h b b</kbd> or <kbd>C-h b b</kbd>
+ Run bin/doom doctor to detect common issues with your de
en and private config.
+ Check out the [FAQ] or [Community FAQs][community-faq], in case your question
has already been answered.
+ Search Doom's issue tracker
in case your issue was already reported.
+ Hop on [our Discord 服务端][discord]; it's active and friendly! Keep an eye on
the #announcements channel, where I announce breaking updates and releases.

Contribute

![PRs Welcome]()
![Elisp styleguide]()
![Donate on liberapay][liberapay]
![Donate on paypal][paypal]

Doom is a labor of love and incurable madness, but I'm only one guy. Doom
wouldn't be where it is today without your help. I welcome contributions of any
kind!

+ I :heart: pull requests and bug reports (see the [Contributing
Guidelines][contribute])!
+ Don't hesitate to tell me my Elisp-fu
sucks, but please
tell me why.
+ Hop on [our Discord 服务端][discord] and say hi! Help others, hang out or talk
to me about Emacs, gamede, physics, pixel art, anime, gaming --
anything you like. Nourish this lonely soul.
+ If you'd like to support my work financially, buy me a drink through
[liberapay] or [paypal]. My work contends with studies, ad in indie
gamedev and freelance work. Donations help me allocate more time to my Emacs
and OSS capers.

LLM Policy

Generative AI is not used in the de of this project (except to test,
debug, and improve LLM
modules).
LLM-generated (or assisted) contributions are highly discouraged, but
tolerated so long as they meet the following criteria:

1. LLM-generated contributions are small,
2. LLM-use is disclosed,
3. Issue and pull request templates are followed (it is disruptive when LLMs omit key information and AI disclosures, or follow arbitrary heading structures),
4. Your M-x doom/info must be uploaded as a file, not published as text in the issue/PR.[^1]
5. A human responds to reviews and questions.

Failing that, related issues/PRs will be immediately closed and refused with
notice. Repeat offenders will be banned.

[^1]: A file-upload is used because doom-infos are filled with keywords that pollute search 引擎 results and make issues harder for users/maintainers to find.

[contribute]: docs/contributing.org
[discord]:
[discuss]:
[community-faq]:
[documentation]: docs/index.org
[faq]:
[getting-started]: docs/getting_started.org
[install]: docs/getting_started.org#install
[backtrace]: docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
[configuration]: docs/getting_started.org#configuring-doom
[package-management]: docs/getting_started.org#package-management
[bin/doom]: docs/getting_started.org#the-bindoom-utility
[common-mistakes]: docs/getting_started.org#common-mistakes-when-configuring-doom-emacs
[change-theme]: docs/faq.org#how-do-i-change-the-theme
[change-font]: docs/faq.org#how-do-i-change-the-fonts
[modules]: docs/modules.org
[popup-system]: modules/ui/popup/README.org
[screenshots]:

[bindings]: modules/config/default/+e.el
[editorconfig]:
[e]:
[fd]:
[gnu emacs]:
[helm]:
[ivy]:
[lsp-mode]:
[eglot]:
[nix]:
[ported-]: modules/editor/e.org#ported-
[ripgrep]:
[straight.el]:
[]:
[]:
[]:
[]:

[liberapay]:
[paypal]:

项目信息

开发语言：Emacs Lisp

Star 数：22724

技术要点

该项目属于黑客技术方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕An Emacs 框架 for the stubborn martian hacker展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。