Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emacs-dashboard/doom-dashboard

Doom Like style for emacs dashboard
https://github.com/emacs-dashboard/doom-dashboard

dashboard doom elisp emacs

Last synced: about 1 month ago
JSON representation

Doom Like style for emacs dashboard

Awesome Lists containing this project

README 

        
[[https://www.gnu.org/licenses/gpl-3.0][https://img.shields.io/badge/License-GPL%20v3-blue.svg]]

[[https://jcs-emacs.github.io/jcs-elpa/#/doom-dashboard][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.ym][https://github.com/emacs-dashboard/doom-dashboard/actions/workflows/test.yml/badge.svg]]



[[https://github.com/doomemacs/doomemacs/tree/master/modules/ui/doom-dashboard][Doom Dashboard]] for [[https://github.com/emacs-dashboard/emacs-dashboard][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:



#+begin_src emacs-lisp

  (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

          (" " . widget-backward)

          (" " . widget-forward)

          (" " . widget-backward)

          (" "  . widget-forward)

          (" " . widget-forward)

          (" "  . 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)))

#+end_src



** 🛠️ Contribute



[[http://makeapullrequest.com][https://img.shields.io/badge/PRs-welcome-brightgreen.svg]]

[[https://github.com/bbatsov/emacs-lisp-style-guide][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:



- [[https://emacs-eask.github.io/][Eask]]

- [[https://www.gnu.org/software/make/][Make]] (optional)



Install all dependencies and development dependencies:



#+begin_src sh

$ eask install-deps --dev

#+end_src



To test the package's installation:



#+begin_src sh

$ eask package

$ eask install

#+end_src



To test compilation:



#+begin_src sh

$ eask compile

#+end_src



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



The built-in =checkdoc= linter:



#+begin_src sh

$ eask lint checkdoc

#+end_src



The standard =package= linter:



#+begin_src sh

$ eask lint package

#+end_src



📝 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 .



See [[./LICENSE][LICENSE]] for details.