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

Vincent Zhang 9337faed5b Optimize: cache project root. Refer to https://github.com/seagle0128/doom-modeline/issues/32.		2018-10-15 20:30:22 +08:00
.gitignore	Update git ignore.	2018-08-23 16:41:09 +08:00
.travis.yml	Update travis CI config.	2018-08-28 23:30:33 +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	Optimize: cache project root.	2018-10-15 20:30:22 +08:00
LICENSE	Initial commit	2018-06-11 23:20:04 +08:00
README.md	Add "Customize" section in doc.	2018-10-07 22:21:09 +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 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 laggy issue, especially while editing remote files via
;; 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 shown)
(setq doom-modeline-python-executable "python")