Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ichernyshovvv/enlight
Highly customizable startup screen for Emacs.
https://github.com/ichernyshovvv/enlight
dashboard emacs startup
Last synced: 39 minutes ago
JSON representation
Highly customizable startup screen for Emacs.
- Host: GitHub
- URL: https://github.com/ichernyshovvv/enlight
- Owner: ichernyshovvv
- License: gpl-3.0
- Created: 2024-05-07T20:46:51.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-01-22T01:45:21.000Z (11 days ago)
- Last Synced: 2025-01-22T02:26:49.707Z (11 days ago)
- Topics: dashboard, emacs, startup
- Language: Emacs Lisp
- Homepage:
- Size: 178 KB
- Stars: 94
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Highly customizable startup screen for Emacs.
Pros:
- lightweight (enlight: 100 loc, enlight-menu: 170 loc) and fast
- no external dependencies (except for [compat](https://github.com/emacs-compat/compat))
- very flexible. `enlight-content` custom is just a string and you decide what
to put into it. That might be just a reminder with a list of tasks to do
today. Or a menu with your often used commands. Or a full-blown dashboard with
a lot of useful (or not) blocks of information (org-agenda, notmuch new emails
count, whatever). See the screenshots below.
TOC
- [Installation](#installation)
- [Usage](#usage)
- [Screenshots and configuration examples](#screenshots-and-configuration-examples)
- [For evil users](#for-evil-users)
- [Thanks](#thanks)
## Installation
This package is available on [MELPA](https://melpa.org/#/getting-started).
``` elisp
M-x package-install enlight
```
## Usage
### Opening at startup
You can set `initial-buffer-choice` custom variable to #'enlight in
order to show enlight right after Emacs startup:
``` elisp
(setopt initial-buffer-choice #'enlight)
```
### Opening manually
Also you always can switch to the buffer by calling
```
M-x enlight-open
```
By default, it will open the buffer in the current window, but you can change
the behaviour by customizing `display-buffer-alist` variable.
## Screenshots and configuration examples
### Simple menu
``` elisp
(use-package enlight
:custom
(enlight-content
(concat
(propertize "MENU" 'face 'highlight)
"\n"
(enlight-menu
'(("Org Mode"
("Org-Agenda (current day)" (org-agenda nil "a") "a"))
("Downloads"
("Transmission" transmission "t")
("Downloads folder" (dired "~/Downloads") "a"))
("Other"
("Projects" project-switch-project "p")))))))
```
### Using grid.el
You can use [grid.el](https://github.com/ichernyshovvv/grid.el) to construct a
bit more complex layouts.
``` elisp
(use-package grid
:init
(unless (package-installed-p 'grid)
(package-vc-install
'(grid
:vc-backend Git
:url "https://github.com/ichernyshovvv/grid.el"
:branch "master"))))
```
#### Two menus placed side by side
``` elisp
(require 'grid)
(use-package enlight
:custom
(enlight-content
(grid-get-row
`(,(enlight-menu
'(("Org Mode"
("Org-Agenda (current day)" (org-agenda nil "a") "a"))
("Downloads"
("Transmission" transmission "t")
("Downloads folder" (dired "~/Downloads") "a"))
("Other"
("Projects" project-switch-project "p"))))
" "
,(enlight-menu
`(("Enlight Settings"
("Jump to the config"
(progn
(find-file ,user-init-file)
(goto-char (point-min))
(search-forward "use-package enlight"))
"j")
("Update"
(let ((beg (point)))
(with-current-buffer
(find-file-noselect ,user-init-file)
(goto-char (point-min))
(search-forward "use-package enlight")
(eval-defun nil)
(enlight))
(goto-char beg))
"g"))))))))
```
#### Complex layout
``` elisp
(require 'grid)
(defvar enlight-lipsum "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.")
(defface enlight-yellow-bold
'((t (:foreground "#cabf00" :bold t)))
"Yellow bold face")
(defvar enlight-guix
(propertize
" .. `.
`--..```..` `..```..--`
.-:///-:::. `-:::///:-.
````.:::` `:::.````
-//:` -::-
://: -::-
`///- .:::`
-+++-:::.
:+/:::-
`-....` "
'face 'enlight-yellow-bold))
(defvar enlight-guix-widget
`( :content ,(concat "\n" (propertize "Block 1" 'face 'enlight-yellow-bold)
"\nGUIX MANAGEMENT WIDGET\n\n")
:width 22 :border t :align center :padding 2))
(defvar enlight-email-width
`( :content
,(concat "\n" (propertize "Block 2" 'face 'enlight-yellow-bold)
"\nEMAIL WIDGET\n\n")
:padding 2 :width 22 :align center :border t))
(defvar enlight-weather-width
`( :content
,(concat "\n" (propertize "Block 3" 'face 'enlight-yellow-bold)
"\nWEATHER WIDGET\n\n")
:padding 2 :width 22 :border t :align center))
(defvar enlight-calendar
(progn
(calendar)
(diary-mark-entries)
(prog1 (with-current-buffer (buffer-name (current-buffer))
(buffer-string))
(calendar-exit))))
(use-package enlight
:custom
(enlight-content
(concat
(grid-get-box `( :align center :content ,enlight-guix :width 80))
(grid-get-row
(list
(grid-get-box
(concat
(grid-get-box
`( :content
,(concat
(grid-get-box `( :content ,(propertize "HEADER" 'face 'highlight)
:width 80 :align center))
(grid-get-row
`(,enlight-guix-widget
" "
,enlight-email-width
" "
,enlight-weather-width)))
:width 80))
enlight-calendar "\n"
(grid-get-row
`(,(concat
(propertize "MENU" 'face 'highlight)
"\n"
(enlight-menu
'(("Org Mode"
("Org-Agenda (current day)" (org-agenda nil "a") "a"))
("Downloads"
("Transmission" transmission "t")
("Downloads folder" (dired "~/Downloads") "a"))
("Other"
("Projects" project-switch-project "p")))))
,(grid-get-column
`(,(propertize "THINGS TO REMEMBER" 'face 'highlight)
(:content ,enlight-lipsum :width 50))))))))))))
```
## For evil users
This package does not work properly in evil mode. Feel free to send a PR to
evil-collection. I have no any experience either in using evil mode or writing
evil integrations.
## Thanks
- Thanks to [a13](https://github.com/a13) and [progfolio](https://github.com/progfolio) for code review.
- Thanks to [G-LDM-N](https://github.com/G-LDM-N) for the logo