emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/modeline
History
Henrik Lissner 77e4cc4d58
💥 Remove :feature category 
:feature was a "catch-all" category. Many of its modules fit better in
other categories, so they've been moved:

- feature/debugger -> tools/debugger
- feature/evil -> editor/evil
- feature/eval -> tools/eval
- feature/lookup -> tools/lookup
- feature/snippets -> editor/snippets
- feature/file-templates -> editor/file-templates
- feature/workspaces -> ui/workspaces

More potential changes in the future:

- A new :term category for terminal emulation modules (eshell, term and
  vterm).
- A new :os category for modules dedicated to os-specific functionality.
  The :tools macos module would fit here, but so would modules for nixos
  and arch.
- A new :services category for web-service integration, like wakatime,
  twitter, elfeed, gist and pastebin services.
2019-04-24 18:16:04 -04:00
..
autoload.el lang/python: refactor python mode-line indication 2019-03-08 02:37:32 -05:00
config.el 💥 Remove :feature category 2019-04-24 18:16:04 -04:00
packages.el 💥 Remove :feature category 2019-04-24 18:16:04 -04:00
README.org ui/modeline: reformat README (WIP) 2019-01-03 02:01:57 -05:00

README.org

ui/modeline

Description

This module provides an Atom-inspired, minimalistic modeline for Doom Emacs, as well as an API for building your own.

  • A match count panel (for evil-search, iedit and evil-substitute)
  • An indicator for recording a macro
  • Local python/ruby version in the major-mode
  • A customizable mode-line height (see +doom-modeline-height)
  • An error/warning count segment for flycheck

/screenshots/ml.png /screenshots/ml-search.png /screenshots/ml-subst.png /screenshots/ml-macro.png /screenshots/ml-version.png /screenshots/ml-errors.png

Module Flags

This module provides no flags.

Plugins

Prerequisites

This module has no prerequisites.

Usage

TODO Hiding the modeline

TODO Switching the modeline and header line

Configuration

TODO Changing the default modeline

TODO Activating a format

TODO Defining a modeline format

TODO Defining a modeline segment

TODO Extracting Doom's modeline into your config

Troubleshooting

Where are my minor modes?

I rarely need to know what minor modes are active, so I removed them. M-x doom/what-minor-mode was written to substitute for it.

TODO Icons in my modeline look strange

Appendix

Commands

This module exposes no public commands.

Autodefs

  • def-modeline-format! NAME LEFT &optional RIGHT
  • def-modeline-segment! NAME &rest REST
  • set-modeline! NAME &optional DEFAULT

Functions

  • +modeline-file-path

Variables

  • +modeline-width
  • +modeline-height
  • +modeline-buffer-path-function
  • +modeline-format-left
  • +modeline-format-rigth

Faces

  • doom-modeline-buffer-path
  • doom-modeline-buffer-file
  • doom-modeline-buffer-modified
  • doom-modeline-buffer-major-mode
  • doom-modeline-highlight
  • doom-modeline-panel
  • doom-modeline-info
  • doom-modeline-warning
  • doom-modeline-urgent
  • doom-modeline-bar

Modeline segments

  • +modeline-buffer-state
  • +modeline-buffer-id
  • +modeline-buffer-directory
  • +modeline-vcs
  • +modeline-encoding
  • +modeline-major-mode
  • +modeline-matches
  • +modeline-selection-info