mirror of https://github.com/correl/doom-modeline.git synced 2024-12-24 03:00:09 +00:00

A fancy and fast mode-line inspired by minimalism design.

Find a file

Amin Bandali 31b94e253a Fix: require subr-x (needed for when-let) Its absence results in a compile error when using borg-build: In toplevel form: doom-modeline.el:314:1:Warning: Unused lexical argument ‘key’ In doom-modeline-set-modeline: doom-modeline.el:314:50:Warning: ‘(modeline (doom-modeline key))’ is a malformed function doom-modeline.el:322:22:Warning: reference to free variable ‘modeline’ In doom-modeline-set-selected-window: doom-modeline.el:390:49:Warning: ‘(win (frame-selected-window))’ is a malformed function doom-modeline.el:393:41:Warning: reference to free variable ‘win’ In end of data: doom-modeline.el:1249:1:Warning: the function ‘when-let’ is not known to be defined. Which ultimately results in an error disrupting proper startup: Invalid function: (modeline (doom-modeline key))		2018-11-10 11:35:47 -05:00
.gitignore	Update git ignore.	2018-08-23 16:41:09 +08:00
.travis.yml	Update README and travis ci.	2018-10-15 20:58:27 +08:00
_config.yml	Set theme jekyll-theme-cayman	2018-07-05 15:29:34 +08:00
Cask	Add cask.	2018-07-05 16:49:42 +08:00
doom-modeline.el	Fix: require subr-x (needed for when-let)	2018-11-10 11:35:47 -05:00
LICENSE	Initial commit	2018-06-11 23:20:04 +08:00
README.md	Update README.	2018-11-02 16:59:50 +08:00

README.md

doom-modeline

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 ace-window, 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)

;; Don’t compact font caches during GC.
;; If you are expereicing the laggy issue especially on Windows, please set to
;; non-nil.
(setq inhibit-compacting-font-caches t)

README.md Unescape Escape