Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 4.48 KB

README.org

File metadata and controls

128 lines (96 loc) · 4.48 KB
Raw

https://img.shields.io/badge/License-GPL%20v3-blue.svg https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/doom-dashboard.svg

Doom Dashboard

https://github.com/emacs-dashboard/doom-dashboard/actions/workflows/test.yml/badge.svg

Doom Dashboard for emacs-dashboard

Dashboard extension for get a look similar to Doom Dashboard! This add 5 new widgets for dashboard!

Screenshot

./etc/screenshot.png

Installation and Configuration:

(use-package doom-dashboard
  ;; For Straight Users
  :straight (doom-dashboard :host github
                                :repo "emacs-dashboard/doom-dashboard")
  ;; Or for built-in package-vc
  ;; :vc (:url "https://github.com/emacs-dashboard/doom-dashboard.git" :rev :newest)
  :after dashboard
  :demand t
  ;; Movement keys like doom.
  :bind
  (:map dashboard-mode-map
        ("<remap> <dashboard-previous-line>" . widget-backward)
        ("<remap> <dashboard-next-line>" . widget-forward)
        ("<remap> <previous-line>" . widget-backward)
        ("<remap> <next-line>"  . widget-forward)
        ("<remap> <right-char>" . widget-forward)
        ("<remap> <left-char>"  . widget-backward))
  :custom
  (dashboard-banner-logo-title "E M A C S")
  (dashboard-startup-banner 
   (concat doom-dashboard-banner-directory "bcc.txt")) ; Use banner you want
  (dashboard-footer-icon 
   (nerd-icons-faicon "nf-fa-github_alt" :face 'success :height 1.5))
  (dashboard-page-separator "\n")
  (dashboard-startupify-list `(dashboard-insert-banner
                               dashboard-insert-banner-title
                               dashboard-insert-newline
                               dashboard-insert-items
                               ,(dashboard-insert-newline 2)
                               dashboard-insert-init-info
                               ,(dashboard-insert-newline 2)
                               doom-dashboard-insert-homepage-footer))
  (dashboard-item-generators
   '((recents   . doom-dashboard-insert-recents-shortmenu)
     (bookmarks . doom-dashboard-insert-bookmark-shortmenu)
     (projects  . doom-dashboard-insert-project-shortmenu)
     (agenda    . doom-dashboard-insert-org-agenda-shortmenu)))
  (dashboard-items '(projects agenda bookmarks recents)))

🛠️ Contribute

https://img.shields.io/badge/PRs-welcome-brightgreen.svg https://img.shields.io/badge/elisp-style%20guide-purple.svg

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package’s installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.