diff --git a/modules/ui/doom/README.org b/modules/ui/doom/README.org index 27fd15624..fead47300 100644 --- a/modules/ui/doom/README.org +++ b/modules/ui/doom/README.org @@ -6,26 +6,32 @@ * Table of Contents :TOC_3:noexport: - [[#description][Description]] - [[#module-flags][Module Flags]] + - [[#plugins][Plugins]] - [[#prerequisites][Prerequisites]] - [[#configuration][Configuration]] - [[#changing-theme][Changing theme]] - [[#changing-fonts][Changing fonts]] - [[#troubleshooting][Troubleshooting]] - [[#strange-font-symbols][Strange font symbols]] + - [[#ugly-background-colors-in-tty-emacs-for-daemon-users][Ugly background colors in tty Emacs for daemon users]] * Description -This module modifies Emacs' user interface. +This module gives Doom its signature look: powered by the =doom-one= theme +(inspired by Atom's One Dark theme) and =solaire-mode=. -Doom's look is loosely inspired by Atom's One Dark theme, and is largely contained in the] plugin. - -+ A colorscheme inspired by Atom's One Dark theme (now available in a separate plugin: [[https://github.com/hlissner/emacs-doom-theme/][doom-themes]]) ++ A colorscheme inspired by Atom's One Dark theme (now available in a separate + plugin: [[https://github.com/hlissner/emacs-doom-theme/][doom-themes]]) + A custom folded-region indicator for ~hideshow~ + "Thin bar" fringe bitmaps for ~git-gutter-fringe~ -+ File-visiting buffers are slightly brighter (powered by solaire-mode) ++ File-visiting buffers are slightly brighter (thanks to solaire-mode) ** Module Flags This module provides no flags. +** Plugins ++ [[https://github.com/hlissner/emacs-doom-themes][doom-themes]] ++ [[https://github.com/hlissner/emacs-solaire-mode][solaire-mode]] + * Prerequisites This module has no prereqisites. @@ -64,4 +70,24 @@ core/core-ui.el has four relevant variables: * Troubleshooting ** Strange font symbols -If you're seeing strange unicode symbols, this is likely because you don't have ~all-the-icons~'s font icon installed. You can install them with ~M-x all-the-icons-install-fonts~. +If you're seeing strange unicode symbols, this is likely because you don't have +~all-the-icons~'s font icon installed. You can install them with ~M-x +all-the-icons-install-fonts~. + +** Ugly background colors in tty Emacs for daemon users +=solaire-mode= is an aesthetic plugin that makes file-visiting buffers brighter +than the rest of the Emacs' frame (to visually differentiate temporary windows +or sidebars from editing windows). This looks great in GUI Emacs, but can look +questionable in the terminal. + +It disables itself if you start tty Emacs with ~emacs -nw~, but if you create a +tty frame from a daemon (which solaire-mode cannot anticipate), you'll get an +ugly background instead. + +If you only use Emacs in the terminal, your best bet is to disable the +solaire-mode package: + +#+BEGIN_SRC elisp +;; in ~/.doom.d/packages.el +(package! solaire-mode :disable t) +#+END_SRC