.github/ISSUE_TEMPLATE | ||
test | ||
.gitignore | ||
.travis.yml | ||
_config.yml | ||
Cask | ||
doom-modeline-core.el | ||
doom-modeline-env.el | ||
doom-modeline-segments.el | ||
doom-modeline.el | ||
LICENSE | ||
README.md |
doom-modeline
Table of Contents
A fancy and fast mode-line inspired by minimalism design.
It's integrated into Centaur Emacs, Doom Emacs and Spacemacs.
Feature
The doom-modeline
was designed for minimalism, and offers:
- A match count panel (for
anzu
,iedit
,multiple-cursors
,symbol-overlay
,evil-search
andevil-substitute
) - An indicator for recording a macro
- Current environment version (e.g.
python
,ruby
,go
, etc.) in the major-mode - A customizable mode-line height (see
doom-modeline-height
) - A minor modes segment which is compatible with
minions
- An error/warning count segment for
flymake
/flycheck
- A workspace number segment for
eyebrowse
- A perspective name segment for
persp-mode
- A window number segment for
ace-window
,winum
andwindow-numbering
- An indicator for modal editing state, including
evil
,overwrite
,god
,ryo
andxah-fly-keys
, etc. - An indicator for remote host
- An indicator for debug state
- An indicator for current input method
- An indicator for LSP state with
lsp-mode
oreglot
- An indicator for GitHub notifications
- An indicator for unread emails with
mu4e-alert
- An indicator for irc notifications with
circe
- An indicator for buffer position which is compatible with
nyan-mode
- An indicator for party parrot
- An indicator for PDF page number with
pdf-tools
- An indicator for markdown/org preview with
grip
- An indicator for battery status with
fancy-battery
- Truncated file name, file icon, buffer state and project name in buffer information segment, which
is compatible with
project
,find-file-in-project
andprojectile
. - New mode-line for
Info-mode
buffers - New package mode-line for
paradox
- New mode-line for
helm
buffers - New mode-line for
git-timemachine
buffers
Screenshots
Install
Manual
From melpa, M-x package-install RET doom-modeline RET
.
In init.el
,
(require 'doom-modeline)
(doom-modeline-mode 1)
Use-package
(use-package doom-modeline
:ensure t
:hook (after-init . doom-modeline-mode))
This package requires the fonts included with all-the-icons
to be installed.
Run M-x all-the-icons-install-fonts
to do so. Please refer to the
installation guide.
Strongly recommend to use doom-themes at the same time.
Customize
Run M-x customize-group RET doom-modeline RET
or set the variables.
;; How tall the mode-line should be. It's only respected in GUI.
;; If the actual char height is larger, it respects the actual height.
(setq doom-modeline-height 25)
;; How wide the mode-line bar should be. It's only respected in GUI.
(setq doom-modeline-bar-width 3)
;; Determines the style used by `doom-modeline-buffer-file-name'.
;;
;; Given ~/Projects/FOSS/emacs/lisp/comint.el
;; truncate-upto-project => ~/P/F/emacs/lisp/comint.el
;; truncate-from-project => ~/Projects/FOSS/emacs/l/comint.el
;; truncate-with-project => emacs/l/comint.el
;; truncate-except-project => ~/P/F/emacs/l/comint.el
;; truncate-upto-root => ~/P/F/e/lisp/comint.el
;; truncate-all => ~/P/F/e/l/comint.el
;; relative-from-project => emacs/lisp/comint.el
;; relative-to-project => lisp/comint.el
;; file-name => comint.el
;; buffer-name => comint.el<2> (uniquify buffer name)
;;
;; If you are expereicing the laggy issue, especially while editing remote files
;; with tramp, please try `file-name' style.
;; Please refer to https://github.com/bbatsov/projectile/issues/657.
(setq doom-modeline-buffer-file-name-style 'truncate-upto-project)
;; Whether display icons in mode-line or not.
(setq doom-modeline-icon (display-graphic-p))
;; Whether display the icon for major mode. It respects `doom-modeline-icon'.
(setq doom-modeline-major-mode-icon t)
;; Whether display color icons for `major-mode'. It respects
;; `doom-modeline-icon' and `all-the-icons-color-icons'.
(setq doom-modeline-major-mode-color-icon t)
;; Whether display icons for buffer states. It respects `doom-modeline-icon'.
(setq doom-modeline-buffer-state-icon t)
;; Whether display buffer modification icon. It respects `doom-modeline-icon'
;; and `doom-modeline-buffer-state-icon'.
(setq doom-modeline-buffer-modification-icon t)
;; Whether display minor modes in mode-line or not.
(setq doom-modeline-minor-modes (featurep 'minions))
;; If non-nil, a word count will be added to the selection-info modeline segment.
(setq doom-modeline-enable-word-count nil)
;; Whether display buffer encoding.
(setq doom-modeline-buffer-encoding t)
;; Whether display indentation information.
(setq doom-modeline-indent-info nil)
;; If non-nil, only display one number for checker information if applicable.
(setq doom-modeline-checker-simple-format t)
;; The maximum displayed length of the branch name of version control.
(setq doom-modeline-vcs-max-length 12)
;; Whether display perspective name or not. Non-nil to display in mode-line.
(setq doom-modeline-persp-name t)
;; Whether display icon for persp name. Nil to display a # sign. It respects `doom-modeline-icon'
(setq doom-modeline-persp-name-icon nil)
;; Whether display `lsp' state or not. Non-nil to display in mode-line.
(setq doom-modeline-lsp t)
;; Whether display GitHub notifications or not. Requires `ghub` package.
(setq doom-modeline-github nil)
;; The interval of checking GitHub.
(setq doom-modeline-github-interval (* 30 60))
;; Whether display mu4e notifications or not. Requires `mu4e-alert' package.
(setq doom-modeline-mu4e t)
;; Whether display irc notifications or not. Requires `circe' package.
(setq doom-modeline-irc t)
;; Function to stylize the irc buffer names.
(setq doom-modeline-irc-stylize 'identity)
;; Whether display environment version or not
(setq doom-modeline-env-version t)
;; Or for individual languages
(setq doom-modeline-env-enable-python t)
(setq doom-modeline-env-enable-ruby t)
(setq doom-modeline-env-enable-perl t)
(setq doom-modeline-env-enable-go t)
(setq doom-modeline-env-enable-elixir t)
(setq doom-modeline-env-enable-rust t)
;; Change the executables to use for the language version string
(setq doom-modeline-env-python-executable "python") ; or `python-shell-interpreter'
(setq doom-modeline-env-ruby-executable "ruby")
(setq doom-modeline-env-perl-executable "perl")
(setq doom-modeline-env-go-executable "go")
(setq doom-modeline-env-elixir-executable "iex")
(setq doom-modeline-env-rust-executable "rustc")
;; What to dispaly as the version while a new one is being loaded
(setq doom-modeline-env-load-string "...")
;; Hooks that run before/after the modeline version string is updated
(setq doom-modeline-before-update-env-hook nil)
(setq doom-modeline-after-update-env-hook nil)
FAQ
-
I am experiencing the laggy issue, how to resolve it?
Add this configuration into your init file:
;; Don’t compact font caches during GC. (setq inhibit-compacting-font-caches t)
-
A ridiculous path is displayed on mode-line while visiting a symbolink.
It's the default behaviors of Vanilla Emacs. If you want to display the real names, please put this into your init file.
(setq find-file-visit-truename t)
If the file is controlled by vc, refer to the documentation of
vc-follow-symlinks
. -
Can I add my mode-line segments myself? How to do that?
Of course. Just add the segments into
global-mode-string
. -
Why doesn't change of branch reflect in modeline?
Actually it's related to
magit
andvc-mode
.- Workaround:
- Revert the buffers manually.
(setq auto-revert-check-vc-info t)
brings the performance issue.
- Refer to:
- Workaround:
-
How can I define my own mode-line?
Use
doom-modeline-def-modeline
to define your own mode-line and set it as default.For example:
- Define your custom doom-modeline
(doom-modeline-def-modeline 'my-simple-line '(bar matches buffer-info remote-host buffer-position parrot selection-info) '(misc-info minor-modes input-method buffer-encoding major-mode process vcs checker))
- Set it to default using the
doom-modeline-mode-hook
:
(defun setup-custom-doom-modeline () (doom-modeline-set-modeline 'my-simple-line 'default)) (add-hook 'doom-modeline-mode-hook 'setup-custom-doom-modeline)
-
How to specify font size in modeline?
For example:
(setq doom-modeline-height 1) (set-face-attribute 'mode-line nil :height 100) (set-face-attribute 'mode-line-inactive nil :height 100)
or
(custom-set-faces '(mode-line ((t (:height 0.9)))) '(mode-line-inactive ((t (:height 0.9)))))
Please refer to #189.