emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/ui/zen
History
Henrik Lissner 037b018cdd
feat: add .doommodule files 
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
autoload.el ui/zen: add +zen/toggle{,-fullscreen} commands 2021-02-24 18:06:30 -05:00
config.el fix(zen): add solaire-line-number-face to mixed-pitch-fixed-pitch-faces 2022-01-28 20:36:13 +01:00
packages.el bump: :ui 2024-02-04 18:58:53 -05:00
README.org docs(*): replace all-the-icons with nerd-icons 2023-09-16 20:19:11 +02:00

README.org

:ui zen

Description   unfold

This module provides two minor modes that make Emacs into a more comfortable writing or coding environment. Folks familiar with "distraction-free" or "zen" modes from other editors – or doom-package:olivetti, doom-package:sublimity, and doom-package:tabula-rasa (Emacs plugins) – will feel right at home.

These modes are:

mixed-pitch-mode
Which renders (most) text in a variable pitch font (see doom-variable-pitch-font). Unlike variable-pitch-mode, this will not affect segments of text that are intended to remain in a fixed pitch font, such as code blocks or ASCII tables.
writeroom-mode

Our all-in-one "zen" mode that will:

  1. Center the current buffer.
  2. Remove superfluous UI elements (like the modeline).
  3. Activate mixed-pitch-mode.
  4. Scale up the buffer's text slightly (see +zen-text-scale).
  5. And make the window's borders slightly thicker (see +zen-window-divider-size).

Maintainers

Become a maintainer?

Module flags

This module has no flags.

Packages

Hacks

  • Doom has disabled all of writeroom-mode's "global" effects (writeroom-global-effects and writeroom-maximize-window are set to nil), and encapsulated them into the +zen/toggle-fullscreen command, whereas +zen/toggle will only operate on the current buffer. This way, the user may choose how far-reaching they want its effect to be.
  • text-scale has been advised to adjust visual-fill-column's margins, so its text won't "squeeze" as you scale it up (or "spill" when scaled down).

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

Usage

This module provides two entry points:

  • M-x +zen/toggle (on <leader> t z): toggles writeroom-mode (restricted to the current buffer).
  • M-x +zen/toggle-fullscreen (on <leader> t Z): toggles zen mode in full-screen mode (deletes other windows and full screens the Emacs frame).

Invoke either command again to undo the change.

TODO Configuration

󱌣 This module has no configuration documentation yet. Write some?

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?