This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+themes/theming/README.org
Titov Andrey 3d434e4ec7 Specific Usage Example for README.org
Example for complete emacs/elisp newbies

from someone who finally made theme customisation work after like ~ 10th attempt
2017-04-17 17:41:00 -04:00

112 lines
3.8 KiB
Org Mode

#+TITLE: Theming layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#install][Install]]
- [[#usage][Usage]]
- [[#example-based-on-thebbs-much-more-broad-gist][Example based on TheBB's (much more broad) gist]]
- [[#attributes][Attributes]]
- [[#faces][Faces]]
- [[#headers][Headers]]
* Description
This layer allows for a simple way of modifying themes.
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =theming= to the existing =dotspacemacs-configuration-layers= list in this
file.
* Usage
To use this layer, set the value of =theming-modifications=. It should be a list
of the following form:
#+begin_src emacs-lisp
((theme1 (face1 attributes...)
(face2 attributes...)
...)
(theme2 (face1 attributes...)
(face2 attributes...)
...)
...)
https://gist.github.com/TheBB/f25a607b9bda4d5861f2#file-init-el-L274
#+end_src
* Example based on TheBB's (much more broad) [[https://gist.github.com/TheBB/f25a607b9bda4d5861f2#file-init-el-L274][gist]]
#+begin_src lisp
;; ~/.spacemacs
;;...
(defun dotspacemacs/user-init ()
;;...
(setq-default
;;... other vars maybe
theming-modifications
'((monokai
;; Font locking
(font-lock-comment-face :slant italic)
(web-mode-html-attr-name-face
:inherit font-lock-variable-name-face :foreground nil)
;; Modeline
(powerline-active1 :box (:color "#999999" :line-width 1 :style released-button)
:background "#5a5a5a"))))
)
#+end_src
This will apply the given attributes to the relevant faces whenever the
appropriate theme is loaded. To update without changing the theme, use ~SPC SPC
spacemacs/update-theme~.
* Attributes
See [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Face-Attributes.html#Face-Attributes][face attributes]] in the Emacs manual for more information. Some of the more
common attributes you might want to tweak are the following:
- =:inherit= :: the name of a face to inherit attributes from
- =:foreground= and =:background= :: Hexadecimal color strings
- =:height= :: typically a floating point number (1.0 gives the same height as
the underlying face)
- =:weight= :: typically =bold= or =normal=
- =:underline= :: typically =nil= or =t=
- =:slant= :: typically =oblique=, =italic= or =normal=
- =:box= :: set to =t= to draw a box around characters in the foreground
* Faces
To see a list over all loaded faces and what they look like, use ~SPC SPC
list-faces-display~. You can also use ~SPC h d c~ (describe character) on a
character to see its face.
Some of the most common faces to modify are the syntactical elements:
- =font-lock-builtin-face=
- =font-lock-comment-delimiter-face=
- =font-lock-comment-face=
- =font-lock-constant-face=
- =font-lock-doc-face=
- =font-lock-function-name-face=
- =font-lock-keyword-face=
- =font-lock-preprocessor-face=
- =font-lock-string-face=
- =font-lock-type-face=
- =font-lock-variable-name-face=
- =font-lock-warning-face=
As well as the mode-line faces for the active and inactive windows:
- =powerline-active1=
- =powerline-active2=
- =powerline-inactive1=
- =powerline-inactive2=
- =mode-line=
- =mode-line-inactive=
* Headers
This layer includes three additional layer variables for tweaking headings.
Allowed values are a list of themes in which the given effect should happen, or
the symbol =all= to apply it on all themes.
- =theming-headings-inherit-from-default= :: inherits all headings from the
default face to avoid non-monospaced fonts
- =theming-headings-same-size= :: sets the =:height= attribute to one on all
headings to give them the same size as the rest of the text
- =theming-headings-bold= :: sets the =:weight= attribute to bold on all
headings