mirror of
https://github.com/doomemacs/doomemacs.git
synced 2025-12-06 02:30:33 -08:00
Merge 8afc54845f into a4a61976dc
This commit is contained in:
commit
63abaa2c29
3 changed files with 49 additions and 29 deletions
|
|
@ -1659,6 +1659,7 @@ You have four options when it comes to launching the sandbox:
|
||||||
All new instances will inherit your ~load-path~ so you can access any packages
|
All new instances will inherit your ~load-path~ so you can access any packages
|
||||||
you have installed.
|
you have installed.
|
||||||
#+END_QUOTE
|
#+END_QUOTE
|
||||||
|
|
||||||
*** Testing packages in the sandbox
|
*** Testing packages in the sandbox
|
||||||
Instances of Emacs launched from the sandbox have inherited your ~load-path~.
|
Instances of Emacs launched from the sandbox have inherited your ~load-path~.
|
||||||
This means you can load packages -- even in Vanilla Emacs -- without worrying
|
This means you can load packages -- even in Vanilla Emacs -- without worrying
|
||||||
|
|
@ -1672,4 +1673,22 @@ sandbox. e.g.
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
** TODO Bisecting your private config
|
** TODO Bisecting your private config
|
||||||
|
|
||||||
|
You can put the following fragment anywhere in your ~config.el~
|
||||||
|
to only load it until that point.
|
||||||
|
|
||||||
|
#+begin_src elisp
|
||||||
|
(with-current-buffer " *load*"
|
||||||
|
(goto-char (point-max)))
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
By progressively moving it and restarting,
|
||||||
|
you can hunt down any configuration issues.
|
||||||
|
|
||||||
|
Upon identifying the culprit,
|
||||||
|
you may try reproducing the issue
|
||||||
|
by running it on a minimal configuration with ~M-:~.
|
||||||
|
|
||||||
** TODO Bisecting Doom Emacs
|
** TODO Bisecting Doom Emacs
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,20 +1,20 @@
|
||||||
#+TITLE: Doom Emacs Documentation
|
#+TITLE: Doom Emacs Documentation
|
||||||
#+STARTUP: nofold
|
#+STARTUP: nofold
|
||||||
|
|
||||||
Doom is a configuration framework for [[https://www.gnu.org/software/emacs/][GNU Emacs 26.3+]] tailored for Emacs
|
Doom is a configuration framework for [[https://www.gnu.org/software/emacs/][GNU Emacs 26.3+]]
|
||||||
bankruptcy veterans who want less framework in their frameworks and the
|
tailored for Emacs bankruptcy veterans who want less framework in their frameworks
|
||||||
performance of a hand rolled config (or better). It can be a foundation for your
|
and the performance of a hand rolled config (or better).
|
||||||
own config or a resource for Emacs enthusiasts to learn more about our favorite
|
It can be a foundation for your own config
|
||||||
OS.
|
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
|
Doom is an opinionated collection of reasonable (and optional) defaults
|
||||||
focus on performance (both runtime and startup) and on abstraction-light,
|
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.
|
readable code design, so that there is less between you and Emacs.
|
||||||
|
|
||||||
#+begin_quote
|
#+begin_quote
|
||||||
The documentation is designed to be viewed within Doom Emacs. Access it by
|
The documentation is designed to be viewed within Doom Emacs.
|
||||||
pressing =SPC h d h= (or =C-h d h= for non-evil users), or search it with =SPC h
|
Access it by pressing =SPC h d h= (or =C-h d h= for non-evil users),
|
||||||
d s= (or =C-h d s=).
|
or search it with =SPC h d s= (or =C-h d s=).
|
||||||
#+end_quote
|
#+end_quote
|
||||||
|
|
||||||
* Table of Contents :TOC:
|
* Table of Contents :TOC:
|
||||||
|
|
@ -26,11 +26,11 @@ d s= (or =C-h d s=).
|
||||||
- [[#workflow-tips-tricks--tutorials][Workflow Tips, Tricks & Tutorials]]
|
- [[#workflow-tips-tricks--tutorials][Workflow Tips, Tricks & Tutorials]]
|
||||||
- [[#module-appendix][Module Appendix]]
|
- [[#module-appendix][Module Appendix]]
|
||||||
- [[#community-resources][Community Resources]]
|
- [[#community-resources][Community Resources]]
|
||||||
- [[#asking-for-help][Asking for help]]
|
- [[#asking-for-help][Asking for Help]]
|
||||||
- [[#project-roadmap][Project roadmap]]
|
- [[#project-roadmap][Project Roadmap]]
|
||||||
- [[#tutorials--guides][Tutorials & guides]]
|
- [[#tutorials--guides][Tutorials & Guides]]
|
||||||
- [[#projects-that-supportcomplement-doom][Projects that support/complement Doom]]
|
- [[#projects-that-supportcomplement-doom][Projects that support/complement Doom]]
|
||||||
- [[#similar-projects][Similar projects]]
|
- [[#similar-projects][Similar Projects]]
|
||||||
|
|
||||||
* TODO Release Notes
|
* TODO Release Notes
|
||||||
|
|
||||||
|
|
@ -63,19 +63,19 @@ d s= (or =C-h d s=).
|
||||||
** [[file:modules.org][Module Appendix]]
|
** [[file:modules.org][Module Appendix]]
|
||||||
|
|
||||||
* Community Resources
|
* Community Resources
|
||||||
** Asking for help
|
** Asking for Help
|
||||||
- [[https://discord.gg/qvGgnVx][Our Discord server]]
|
- [[https://discord.gg/qvGgnVx][Our Discord server]]
|
||||||
- [[https://github.com/hlissner/doom-emacs/issues][Our issue tracker]]
|
- [[https://github.com/hlissner/doom-emacs/issues][Our issue tracker]]
|
||||||
|
|
||||||
** Project roadmap
|
** Project Roadmap
|
||||||
- [[https://github.com/hlissner/doom-emacs/projects/3][Development roadmap]] - A timeline outlining what's being worked on and when it
|
- [[https://discourse.doomemacs.org/t/development-roadmap/42][Development roadmap]] - A timeline outlining what's being worked on and when it
|
||||||
is expected to be done.
|
is expected to be done.
|
||||||
- [[https://github.com/hlissner/doom-emacs/projects/2][Plugins under review]] - A sitrep on third party plugins that we've considered,
|
- [[https://github.com/orgs/doomemacs/projects/5][Packages under review]] - A sitrep on third party plugins that we've considered,
|
||||||
rejected, or awaiting integration into Doom.
|
rejected, or awaiting integration into Doom.
|
||||||
- [[https://github.com/hlissner/doom-emacs/projects/5][Upstream bugs]] - Tracks issues originating from plugins and external programs
|
- [[https://github.com/orgs/doomemacs/projects/7][Upstream bugs]] - Tracks issues originating from plugins and external programs
|
||||||
that Doom relies on.
|
that Doom relies on.
|
||||||
|
|
||||||
** Tutorials & guides
|
** Tutorials & Guides
|
||||||
+ *Doom Emacs*
|
+ *Doom Emacs*
|
||||||
- (videos) [[https://www.youtube.com/playlist?list=PLyy8KUDC8P7X6YkegqrnEnymzMWCNB4bN][Doom Emacs Tutorials]] by [[https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg][DistroTube]]
|
- (videos) [[https://www.youtube.com/playlist?list=PLyy8KUDC8P7X6YkegqrnEnymzMWCNB4bN][Doom Emacs Tutorials]] by [[https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg][DistroTube]]
|
||||||
- (videos) [[https://www.youtube.com/playlist?list=PLhXZp00uXBk4np17N39WvB80zgxlZfVwj][DoomCasts]] by @zaiste
|
- (videos) [[https://www.youtube.com/playlist?list=PLhXZp00uXBk4np17N39WvB80zgxlZfVwj][DoomCasts]] by @zaiste
|
||||||
|
|
@ -97,10 +97,10 @@ d s= (or =C-h d s=).
|
||||||
- [[https://gist.github.com/dmsul/8bb08c686b70d5a68da0e2cb81cd857f][A crash course on modal editing and Ex commands]]
|
- [[https://gist.github.com/dmsul/8bb08c686b70d5a68da0e2cb81cd857f][A crash course on modal editing and Ex commands]]
|
||||||
|
|
||||||
** Projects that support/complement Doom
|
** Projects that support/complement Doom
|
||||||
+ [[https://github.com/plexus/chemacs][plexus/chemacs]]
|
+ [[https://github.com/plexus/chemacs2][plexus/chemacs2]] - emacs profile switcher
|
||||||
+ [[https://github.com/r-darwish/topgrade][r-darwish/topgrade]]
|
+ [[https://github.com/topgrade-rs/topgrade][topgrade]] - system updater that includes doom
|
||||||
|
|
||||||
** Similar projects
|
** Similar Projects
|
||||||
+ [[https://github.com/purcell/emacs.d][purcell/emacs.d]]
|
+ [[https://github.com/purcell/emacs.d][purcell/emacs.d]] - a wise mans long-grown emacs config
|
||||||
+ [[https://github.com/seagle0128/.emacs.d][seagle0128/.emacs.d]]
|
+ [[https://github.com/seagle0128/.emacs.d][seagle0128/.emacs.d]] - centaur emacs, a personal distribution
|
||||||
+ [[https://github.com/syl20bnr/spacemacs][syl20bnr/spacemacs]]
|
+ [[https://github.com/syl20bnr/spacemacs][syl20bnr/spacemacs]] - spacemacs, an alternative community-driven distribution
|
||||||
|
|
|
||||||
|
|
@ -42,9 +42,10 @@ loaded last*, before =:config= modules.
|
||||||
Modules that provide new interfaces or frameworks for completion, including code
|
Modules that provide new interfaces or frameworks for completion, including code
|
||||||
completion.
|
completion.
|
||||||
|
|
||||||
+ [[file:../modules/completion/company/README.org][company]] =+childframe +tng= - The ultimate code completion backend
|
+ [[file:../modules/completion/corfu/README.org][corfu]] - The lightweight, customizable code completion backend
|
||||||
+ helm =+fuzzy +childframe= - *Another* search engine for love and life
|
+ [[file:../modules/completion/company/README.org][company]] =+childframe +tng= - The ultimate code completion backend (deprecated)
|
||||||
+ ido - The /other/ *other* search engine for love and life
|
+ [[file:../modules/completion/helm/README.org][helm]] =+fuzzy +childframe= - *Another* search engine for love and life
|
||||||
|
+ [[file:../modules/completion/ido/README.org][ido]] - The /other/ *other* search engine for love and life
|
||||||
+ [[file:../modules/completion/ivy/README.org][ivy]] =+fuzzy +prescient +childframe +icons= - /The/ search engine for love and life
|
+ [[file:../modules/completion/ivy/README.org][ivy]] =+fuzzy +prescient +childframe +icons= - /The/ search engine for love and life
|
||||||
+ [[file:../modules/completion/vertico/README.org][vertico]] =+icons= - The search engine of the future
|
+ [[file:../modules/completion/vertico/README.org][vertico]] =+icons= - The search engine of the future
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue