Skip to content

Simple elegant welcome screen / dashboard for Emacs

License

Notifications You must be signed in to change notification settings

jjba23/welkomscherm.el

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

welkomscherm.el

welkomscherm means welcome screen in the Dutch language.

GNU Emacs

Simple, customizable and elegant dashboard package for Emacs. Compatible with GUI and TUI Emacs (> 25).

Installing

This package is not (yet) available in popular Emacs repositories such as MELPA or ELPA. An example installation with Elpaca:

(use-package welkomscherm
  :ensure (:host github :repo "jjba23/welkomscherm.el" :branch "trunk")
  :bind (("C-c SPC SPC" . welkomscherm))
  :init
  (setq welkomscherm-use-form-feed nil
        welkomscherm-centered t
        welkomscherm-use-section-title t)

  (setq welkomscherm-bookmarks-personal
        '((("dotfiles" . "~/Dev/Personal/dotfiles/")
           ("notes" . "~/Dev/Personal/private-notes/")
           ("emacs config" . "~/Dev/Personal/dotfiles/users/joe/emacs/init.el")
           )
          (("second-row-api" . "~/Dev/Personal/second-row-api/README.md")
           ("second-row-ssr" . "~/Dev/Personal/second-row-ssr/"))))
  
  (setq welkomscherm-bookmarks-work
        '((("my-work" . "~/Dev/Work/my-work/")
           ("hem-wiki" . "~/Dev/Work/hem-wiki/"))))

  (setq welkomscherm-buttons-actions
        '((("*scratch*" . (lambda (btn) (switch-to-buffer "*scratch*")))
           ("*Messages*" . (lambda (btn) (switch-to-buffer "*Messages*")))
           ("re-render me" . (lambda (btn) (welkomscherm)))))))

Welkomscherm at startup

If you want the welkomscherm to be your initial buffer when you start a new emacsclient (either GUI or terminal) then add this to your Emacs config:

(setq initial-buffer-choice
      (lambda () (welkomscherm) (get-buffer welkomscherm-buffer-name)))

Do note that if using use-package it’s recommendable to apply this setting in your (use-package emacs) declaration.

Project management - Backlog

Add recent files section, think also of recent projects with project.el, and allow user to provide mechanisms to abbreviate paths

About

Simple elegant welcome screen / dashboard for Emacs

Topics

Resources

License

Stars

Watchers

Forks