Skip to content

Latest commit

 

History

History
117 lines (92 loc) · 4.12 KB

README.org

File metadata and controls

117 lines (92 loc) · 4.12 KB
Raw

:ui doom-dashboard

Description

This module adds a minimalistic, Atom-inspired dashboard to Emacs.

Besides eye candy, the dashboard serves two other purposes:

  1. To improve Doom’s startup times (the dashboard is lighter than the scratch buffer in many cases).
  2. And to preserve the “last open directory” you were in. Occasionally, I kill the last buffer in my project and I end up who-knows-where (in the working directory of another buffer/project). It can take some work to find my way back to where I was. Not with the Dashboard.

    Since the dashboard cannot be killed, and it remembers the working directory of the last open buffer, M-x find-file will work from the directory I expect.

Maintainers

  • @hlissner

Become a maintainer?

Module flags

This module has no flags.

Packages

This module doesn’t install any packages.

Hacks

No hacks documented for this module.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module only requires that nerd-icons’s icon fonts are installed, which should’ve been installed when you ran $ doom install. Otherwise, use M-x nerd-icons-install-fonts to install them.

Usage

Once this module is enabled, the dashboard will present itself after opening a fresh instance of Emacs, or after killing all real buffers.

You can forcibly open the dashboard with M-x +doom-dashboard/open.

Configuration

󱌣 This module’s configuration documentation is incomplete. Complete it?

A custom banner

To use a custom image as your banner, change fancy-splash-image:

(setq fancy-splash-image "~/my/banners/image.png")

󰐃 Doom will fall back to its ASCII banner in Terminal Emacs. To replace the ASCII banner, replace the doom-dashboard-widget-banner function in +doom-dashboard-functions with a function that inserts your new banner into the current file.

Adding text to the dashboard

Doom’s dashboard iterates over +doom-dashboard-functions when it is told to redraw. Add your own functions to operate on the buffer and potentially add whatever you like to Doom’s splash screen.

 Keep in mind that inserting text from expensive sources, e.g. your org agenda, will negate most of Doom’s startup benefits.

Customizing Faces

Doom’s dashboard defaults to inheriting faces set by the current theme. If you wish to customize it independently of the theme (or just inherit a different color from the theme) you can make use of custom-set-faces! or custom-theme-set-faces!:

(custom-set-faces!
  '(doom-dashboard-banner :foreground "red" :background "#000000" :weight bold)
  '(doom-dashboard-footer :inherit font-lock-constant-face)
  '(doom-dashboard-footer-icon :inherit nerd-icons-red)
  '(doom-dashboard-loaded :inherit font-lock-warning-face)
  '(doom-dashboard-menu-desc :inherit font-lock-string-face)
  '(doom-dashboard-menu-title :inherit font-lock-function-name-face))

or for a per-theme setting

(custom-theme-set-faces! 'doom-tomorrow-night
  '(doom-dashboard-banner :foreground "red" :background "#000000" :weight bold)
  '(doom-dashboard-footer :inherit font-lock-constant-face)
  '(doom-dashboard-footer-icon :inherit nerd-icons-red)
  '(doom-dashboard-loaded :inherit font-lock-warning-face)
  '(doom-dashboard-menu-desc :inherit font-lock-string-face)
  '(doom-dashboard-menu-title :inherit font-lock-function-name-face))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

󱌣 This module has no appendix yet. Write one?