mirror of
https://github.com/correl/doom-modeline.git
synced 2024-11-27 19:19:53 +00:00
103 lines
4.1 KiB
Markdown
103 lines
4.1 KiB
Markdown
# doom-modeline
|
||
|
||
[](https://travis-ci.org/seagle0128/doom-modeline)
|
||
[](https://melpa.org/#/doom-modeline)
|
||
[](https://stable.melpa.org/#/doom-modeline)
|
||
[](http://www.gnu.org/licenses/gpl-3.0.html)
|
||
|
||
A fancy mode-line from [DOOM Emacs](https://github.com/hlissner/doom-emacs/tree/master/modules/ui/doom-modeline).
|
||
It's integrated to [Centaur Emacs](https://github.com/seagle0128/.emacs.d).
|
||
|
||
## 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
|
||
- Highlight project name in buffer information if `projectile` or `project` is available.
|
||
|
||
## Install
|
||
|
||
### Manual
|
||
|
||
From melpa, `M-x package-install RET doom-modeline RET`.
|
||
|
||
In `init.el`,
|
||
|
||
``` emacs-lisp
|
||
(require 'doom-modeline)
|
||
(doom-modeline-init)
|
||
```
|
||
|
||
### Use-package
|
||
|
||
``` emacs-lisp
|
||
;; Don't load after init time.
|
||
(use-package doom-modeline
|
||
:ensure t
|
||
:defer t
|
||
: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](https://github.com/hlissner/emacs-doom-themes);
|
||
|
||
## Customize
|
||
|
||
``` emacs-lisp
|
||
;; 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)
|
||
```
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|