protesilaos.modus-themes/README.md
Protesilaos Stavrou 47fa423e8f
Warn about potential issues with custom theme path
Thanks to Adrian Manea for the feedback in issue 156:
<https://gitlab.com/protesilaos/modus-themes/-/issues/156>.
2021-02-02 20:14:20 +02:00

51 lines
1.7 KiB
Markdown

# Modus themes (Modus Operandi and Modus Vivendi)
A pair of highly accessible themes that conform with the WCAG AAA
standard for colour contrast between background and foreground
combinations (a minimum contrast of 7:1---the highest standard of its
kind).
The themes are built into GNU Emacs 28 (development target). They are
also distributed in several packages formats.
+ `modus-operandi` is light
+ `modus-vivendi` is dark
## Quick setup for the latest version
```elisp
(use-package modus-themes
:ensure
:init
;; Add all your customizations prior to loading the themes
(setq modus-themes-slanted-constructs t
modus-themes-bold-constructs nil)
;; Load the theme files before enabling a theme
(modus-themes-load-themes)
:config
;; Load the theme of your choice:
(modus-themes-load-operandi) ;; OR (modus-themes-load-vivendi)
:bind ("<f5>" . modus-themes-toggle))
```
Note: make sure that you **do not customise** `custom-theme-load-path`
or `custom-theme-directory` _after_ the themes' package declaration.
That will lead to failures in loading the files. If you must change
those variables, do it before the package declaration.
## Further information
Read the [Info manual HTML](https://protesilaos.com/modus-themes)
version for how to install, load, enable, and customise the themes. If
you are using the latest version of the themes, you already have the
manual installed: evaluate `(info "(modus-themes) Top")` to start
reading it.
The themes cover a broad range of packages and are highly customisable.
For some demo content, check:
+ the screenshots https://protesilaos.com/modus-themes-pictures/
+ my videos https://protesilaos.com/code-casts/