doom-modeline/README.md
Vincent Zhang 5aa211cf04 Enable all-the-icons in terminal.
Use doom-modeline-icon to enable/disable icons.
2018-10-25 16:11:03 +08:00

3.8 KiB

doom-modeline

Build Status MELPA MELPA Stable License

A fancy mode-line from DOOM Emacs. It's integrated to Centaur Emacs.

Feature

The DOOM modeline was designed for minimalism, and offers:

  • A match count panel (for anzu, iedit, multi-cusor, evil-search and evil-substitute)
  • An indicator for recording a macro
  • Local python/ruby/perl/go/elixir version in the major-mode
  • A customizable mode-line height (see doom-modeline-height)
  • An error/warning count segment for flycheck
  • A workspace number segment for eyebrowse
  • A window number segment for winum and window-numbering
  • An indicator for evil state
  • An indicator for current input method

Install

Manual

From melpa, M-x package-install RET doom-modeline RET.

In init.el,

(require 'doom-modeline)
(doom-modeline-init)

Use-package

(use-package doom-modeline
      :ensure t
      :defer t
      :hook (after-init . doom-modeline-init))

This package requires the fonts included with all-the-icons to be installed. Run M-x all-the-icons-install-fonts to do so.

Recommand to use doom-themes;

Customize

;; How tall the mode-line should be (only respected in GUI Emacs).
(setq doom-modeline-height 25)

;; How wide the mode-line bar should be (only respected in GUI Emacs).
(setq doom-modeline-bar-width 3)

;; Determines the style used by `doom-modeline-buffer-file-name'.
;; If you are expereicing the laggy issue, especially while editing remote files
;; with tramp, please use `file-name', `truncate-all' or `truncate-upto-root'
;; style.
;; Please refer to https://github.com/bbatsov/projectile/issues/657.
(setq doom-modeline-buffer-file-name-style 'truncate-upto-project)

;; What executable of Python will be used (if nil nothing will be showed).
(setq doom-modeline-python-executable "python")

;; Whether show `all-the-icons' or not (if nil nothing will be showed).
;; The icons may not be showed correctly on Windows. Disable to make it work.
(setq doom-modeline-icon t)

Screenshots

modeline

search

subst

macro

version errors

evil normal state evil emacs state

evil insert sate evil viusal state

evil motion state evil operator state