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/typography/README.org
2015-11-19 01:16:46 -05:00

64 lines
2.6 KiB
Org Mode

#+TITLE: typography contribution layer for Spacemacs
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../../../css/readtheorg.css" />
* Table of Contents :TOC_4_org:noexport:
- [[Description][Description]]
- [[Install][Install]]
- [[Key bindings][Key bindings]]
- [[Typo Mode][Typo Mode]]
- [[Tildify Mode][Tildify Mode]]
* Description
This layer provides support for typographic text editing in Spacemacs. It
provides modes to automatically insert and cycle among typographic characters:
- [[https://github.com/jorgenschaefer/typoel][Typo Mode]] automatically inserts and cycles among typographic Unicode
characters on some keys.
- Tildify Mode automatically inserts non-breaking spaces where required. (Only
available on Emacs 25).
* Install
To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(typography))
#+END_SRC
Typographic editing however is disabled by default. To enable it by default set
=typography-enable-typographic-editing= to =t=:
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers
'(typography :variables typography-enable-typographic-editing t))
#+END_SRC
This setting enables automatic insertion of non-breaking spaces where required
and automatic insertion and cycling among of typographic quotes and dashes.
* Key bindings
| Key Bindings | Description |
|--------------+------------------------------------------------------------------|
| ~SPC t T~ | Toggle Typo Mode (automatic insertion of typographic characters) |
| ~SPC t ~~ | Toggle Tildify Mode (automatic insertion of non-breaking spaces) |
| ~SPC x ~~ | Insert non-breaking spaces in the current region |
The following keybindings are available in insert state.
** Typo Mode
| Key Bindings | Description |
|--------------+------------------------------------------|
| ~"~ | Cycle among quotation marks |
| ~`~ | Cycle among left single quotation marks |
| ~'~ | Cycle among right single quotation marks |
| ~-~ | Cycle among dashes |
| ~.~ | Cycle among ellipsis |
| ~<~ | Cycle among left angle brackets |
| ~>~ | Cycle among right angle brackets |
** Tildify Mode
| Key bindings | Description |
|--------------+-----------------------------------------|
| ~SPC~ | Insert non-breaking space when required |