[Fix #103] Add documentation for editor
This commit is contained in:
parent
39b88fe334
commit
973278140e
63
modules/editor/README.md
Normal file
63
modules/editor/README.md
Normal file
|
@ -0,0 +1,63 @@
|
|||
Editor
|
||||
======
|
||||
|
||||
Sets key bindings.
|
||||
|
||||
Settings
|
||||
--------
|
||||
|
||||
### Key bindings
|
||||
|
||||
To enable key bindings, add the following to *zpreztorc*, and replace 'map' with
|
||||
'emacs' or 'vi'.
|
||||
|
||||
zstyle ':prezto:module:editor' keymap 'map'
|
||||
|
||||
### Dot Expansion
|
||||
|
||||
To enable the auto conversion of .... to ../.., add the following to
|
||||
*zpreztorc*.
|
||||
|
||||
zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
|
||||
Theming
|
||||
-------
|
||||
|
||||
To indicate when the editor is in the primary keymap (emacs or viins), add
|
||||
the following to your `theme_prompt_setup` function.
|
||||
|
||||
zstyle ':prezto:module:editor:info:keymap:primary' format '>>>'
|
||||
|
||||
To indicate when the editor is in the primary keymap (emacs or viins) insert
|
||||
mode, add the following to your `theme_prompt_setup` function.
|
||||
|
||||
zstyle ':prezto:module:editor:info:keymap:primary:insert' format 'I'
|
||||
|
||||
To indicate when the editor is in the primary keymap (emacs or viins) overwrite
|
||||
mode, add the following to your `theme_prompt_setup` function.
|
||||
|
||||
zstyle ':prezto:module:editor:info:keymap:primary:overwrite' format 'O'
|
||||
|
||||
To indicate when the editor is in the alternate keymap (vicmd), add the
|
||||
following to your `theme_prompt_setup` function.
|
||||
|
||||
zstyle ':prezto:module:editor:info:keymap:alternate' format '<<<'
|
||||
|
||||
To indicate when the editor is completing, add the following to your
|
||||
`theme_prompt_setup` function.
|
||||
|
||||
zstyle ':prezto:module:editor:info:completing' format '...'
|
||||
|
||||
Then add `$editor_info[context]`, where context is *keymap*, *insert*, or
|
||||
*overwrite*, to `$PROMPT` or `$RPROMPT` and call `editor-info` in the
|
||||
`prompt_name_preexec` hook function.
|
||||
|
||||
Authors
|
||||
-------
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][1].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
|
||||
[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues
|
||||
|
|
@ -4,42 +4,6 @@
|
|||
# Authors:
|
||||
# Sorin Ionescu <sorin.ionescu@gmail.com>
|
||||
#
|
||||
# Usage:
|
||||
# To enable key bindings, add the following to zpreztorc, and replace 'map'
|
||||
# with 'emacs' or 'vi.
|
||||
#
|
||||
# zstyle ':prezto:module:editor' keymap 'map'
|
||||
#
|
||||
# To enable the auto conversion of .... to ../.., add the following to
|
||||
# zpreztorc.
|
||||
#
|
||||
# zstyle ':prezto:module:editor' dot-expansion 'yes'
|
||||
#
|
||||
# To indicate when the editor is in the primary keymap (emacs or viins), add
|
||||
# the following to your theme prompt setup function.
|
||||
#
|
||||
# zstyle ':prezto:module:editor:info:keymap:primary' format '>>>'
|
||||
#
|
||||
# To indicate when the editor is in the primary keymap (emacs or viins) insert
|
||||
# mode, add the following to your theme prompt setup function.
|
||||
#
|
||||
# zstyle ':prezto:module:editor:info:keymap:primary:insert' format 'I'
|
||||
#
|
||||
# To indicate when the editor is in the primary keymap (emacs or viins)
|
||||
# overwrite mode, add the following to your theme prompt setup function.
|
||||
#
|
||||
# zstyle ':prezto:module:editor:info:keymap:primary:overwrite' format 'O'
|
||||
#
|
||||
# To indicate when the editor is in the alternate keymap (vicmd), add the
|
||||
# following to your theme prompt setup function.
|
||||
#
|
||||
# zstyle ':prezto:module:editor:info:keymap:alternate' format '<<<'
|
||||
#
|
||||
# To indicate when the editor is completing, add the following to your theme
|
||||
# prompt setup function.
|
||||
#
|
||||
# zstyle ':prezto:module:editor:info:completing' format '...'
|
||||
#
|
||||
|
||||
# Return if requirements are not found.
|
||||
if [[ "$TERM" == 'dumb' ]]; then
|
||||
|
|
Loading…
Reference in a new issue