GitHub - emacs-dashboard/emacs-dashboard: An extensible emacs dashboard
source link: https://github.com/emacs-dashboard/emacs-dashboard
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.org
Emacs Dashboard
An extensible emacs startup screen showing you what’s most important.
Features
- Displays an awesome Emacs banner!
- Recent files
- Bookmarks list
- Recent projectile projects list (Depends on `projectile` package)
- Org mode agenda
- Register list
Screenshot
Dependencies
You will need the following packages which are all available on Melpa:
- page-break-lines - https://github.com/purcell/page-break-lines
- (optional) projectile - https://github.com/bbatsov/projectile
Usage
M-x package-install RET dashboard
(require 'dashboard) (dashboard-setup-startup-hook) ;; Or if you use use-package (use-package dashboard :ensure t :config (dashboard-setup-startup-hook))
By default, this will show three lists, recent files and bookmarks and org-agenda items. One more widget is implemented by Dashboard but it’s made optional because of it’s dependency on a third party application, which is `projects` which shows you the list of known projectile projects.
Emacs Daemon
In addition to the above, configure initial-buffer-choice
to show
Dashboard in frames created with emacsclient -c
as follows:
(setq initial-buffer-choice (lambda () (get-buffer "*dashboard*")))
Configuration
To update the banner or banner title
;; Set the title (setq dashboard-banner-logo-title "Welcome to Emacs Dashboard") ;; Set the banner (setq dashboard-startup-banner [VALUE]) ;; Value can be ;; 'official which displays the official emacs logo ;; 'logo which displays an alternative emacs logo ;; 1, 2 or 3 which displays one of the text banners ;; "path/to/your/image.png" which displays whatever image you would prefer ;; Content is not centered by default. To center, set (setq dashboard-center-content t) ;; To disable shortcut "jump" indicators for each section, set (setq dashboard-show-shortcuts nil)
To customize which widgets are displayed, you can use the following snippet
(setq dashboard-items '((recents . 5) (bookmarks . 5) (projects . 5) (agenda . 5) (registers . 5)))
This will add the recent files, bookmarks, projects, org-agenda and registers widgets to your dashboard each displaying 5 items.
To add your own custom widget is pretty easy, define your widget’s callback function and add it to `dashboard-items` as such:
(defun dashboard-insert-custom (list-size) (insert "Custom text")) (add-to-list 'dashboard-item-generators '(custom . dashboard-insert-custom)) (add-to-list 'dashboard-items '(custom) t)
Org mode’s agenda
To display today’s agenda items on the dashboard, add agenda
to dashboard-items
:
(add-to-list 'dashboard-items '(agenda) t)
To show agenda for the upcoming seven days set the variable show-week-agenda-p
to t
.
(setq show-week-agenda-p t)
Note that setting list-size for the agenda list is intentionally ignored; all agenda items for the current day will be displayed.
Faces
It is possible to customize Dashboard’s appearance using the following faces:
dashboard-banner-logo-title
Highlights the banner title.
dashboard-text-banner
Highlights text banners.
dashboard-heading
Highlights widget headings.
widget-button
Highlights widget items.
Shortcuts
You can use any of the following shortcuts inside Dashboard
ShortcutFunctionTab Or C-iNext ItemShift-TabPrevious ItemReturn / Mouse Click / C-mOpenrRecent filesmBookmarkspProjectsaOrg-Mode AgendaeRegistersgRefresh contents{Previous section}Next sectionWish List
- [X] Center content
- [X] More banner options
- [X] Customizing the list of widgets to display
- [X] Integrate Org-mode’s agenda
- [ ] Listing Perspectives
Contributions
To contribute your changes to this package, please do the following:
- Fork the repo
- Clone a local copy
- Make your changes
- Push and create your PR
When working on this package, it’s typical to uninstall dashboard, develop your changes and then install this as “development version”.
This is accomplished with the following steps:
# In emacs: M-x package-delete dashboard-<version> RET
make build make install
Prerequisites
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK