Skip to content

Commit

Permalink
Add new entry to FAQ.org (emacs-dashboard#525)
Browse files Browse the repository at this point in the history
* Fix emacs-dashboard#471

dashboard-replace-displayable doesn't return nerd-icon string due apparently internal-char-font only return non-nil if it is only
displayable with current frame font, this is a problem to some user that doesn't using any nerd patched font as default, also due nerd-font can use any character for its icons it's necessary return string if nerd-icons is avalaible.
The same applies to all-the-icons

This may close: emacs-dashboard#471 and emacs-dashboard#467

* Fix insert-startupify-list failing with cons cells

* Add new entry to FAQ.org

Due Windows port doesn't handle well with icons in dashboard,
I think it's good idea add a new entry into FAQ file about How
to fix this issue.

I've also improve it a little.
  • Loading branch information
DevelopmentCool2449 authored Apr 7, 2024
1 parent 89b42bf commit 263f9f1
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions docs/FAQ.org
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
* Frequently Asked Questions
#+title: Frequently Asked Questions

** /How can i hide modeline in dashboard?/
* /How can i hide modeline in dashboard?/

You can add this to your config:
#+begin_src emacs-lisp
Expand All @@ -19,7 +19,20 @@ For doom-modeline users you may use this:
(add-to-list 'doom-modeline-mode-alist '(dashboard-mode))
#+end_src

** /How can i use [[https://github.com/hlissner/emacs-solaire-mode][solaire-mode]] with dashboard?/
* /Icons doesn't display in Windows GUI, How can i fix it?/
Emacs Windows port doesn't handle well icons.

For *nerd-icons* you can use *patched nerd fonts* found in their official
website [[https://www.nerdfonts.com/font-downloads]].

Otherwise you can use *UTF-8* coding system, putting this line into
your =early-init.el=
#+begin_src emacs-lisp
(if (eq system-type 'windows-nt)
(prefer-coding-system 'utf-8))
#+end_src

* /How can i use [[https://github.com/hlissner/emacs-solaire-mode][solaire-mode]] with dashboard?/

Add this to your config:
#+begin_src emacs-lisp
Expand All @@ -31,7 +44,7 @@ Add this to your config:
#+end_src


** /How can i add my custom widget?/
* /How can i add my custom widget?/

To add your own custom widget is pretty easy, define your widget's callback function and add it to `dashboard-items` as such:
#+BEGIN_SRC elisp
Expand All @@ -57,19 +70,19 @@ If you want to add an icon to a custom widget, insert it with `dashboard-insert-
#+END_SRC


** Items length is too high How can i change it
* Items length is too high How can i change it
You can change dashboard-items-default-length amount:
#+BEGIN_SRC elisp
(setq dashboard-items-default-length 20)
#+END_SRC

** /How can i change dashboard buffer name?/
* /How can i change dashboard buffer name?/
You can change it with ~dashboard-buffer-name~
#+begin_src emacs-lisp
(setq dashboard-buffer-name "*my dashboard*")
#+end_src

** /I don't like banner, init info or even items, How can i delete them from dashboard?/
* /I don't like banner, init info or even items, How can i delete them from dashboard?/

You can delete them from ~dashboard-startupify-list~.
#+begin_src emacs-lisp
Expand All @@ -79,14 +92,14 @@ You can delete them from ~dashboard-startupify-list~.
dashboard-insert-footer))
#+end_src

** /How can i change my init message?/
* /How can i change my init message?/

You can customize it like this:
#+BEGIN_SRC elisp
(setq dashboard-init-info "This is an init message!")
#+END_SRC

** /How can i change footer messages?/
* /How can i change footer messages?/

You can customize it like this:
#+BEGIN_SRC elisp
Expand Down

0 comments on commit 263f9f1

Please sign in to comment.