dcarrillo
/
prezto
mirror of https://github.com/dcarrillo/prezto.git
1
0
Fork 0
Code Issues Releases Wiki Activity
prezto/modules/syntax-highlighting/README.md

79 lines
2.1 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Syntax Highlighting
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
Integrates [zsh-syntax-highlighting][1] into Prezto.
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
This module must be loaded _before_ the _`prompt`_ module.
syntax-highlighting: Update README to clarify module load order Fixes #1584
2018-06-18 21:16:36 +00:00
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
If this module is used in conjunction with the [_`history-substring-search`_][2]
module, this module must be loaded _before_ the _`history-substring-search`_
module.
syntax-highlighting: Update README to clarify module load order Fixes #1584
2018-06-18 21:16:36 +00:00
Additionally, if this module is used in conjunction with the
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
[_`autosuggestions`_][3] module, this module must be loaded _before_ the
_`autosuggestions`_ module as well.
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To elaborate, the relative order of loading the modules would be
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
_`syntax-highlighting`_, _`history-substring-search`_, _`autosuggestions`_ and
_`prompt`_.
syntax-highlighting: Further clarify relative module ordering
2018-12-13 05:02:59 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Contributors
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
New features and bug fixes should be submitted to the
[zsh-syntax-highlighting][1] project according to its rules and regulations.
This module will be synchronized against it.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Settings
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
### Highlighting
[Fix #253] Move Prezto settings into their own file
2012-09-03 20:38:18 +00:00
To enable highlighting for this module only, add the following line to
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:syntax-highlighting' color 'yes'
```
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
### Highlighters
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
Syntax highlighting is accomplished by pluggable [highlighters][4]. This module
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
only enables the _main_ highlighter by default.
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
To enable all highlighters, add the following to
_`${ZDOTDIR:-$HOME}/.zpreztorc`_.
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:syntax-highlighting' highlighters \
'main' \
'brackets' \
'pattern' \
Add missing highlighter to readme This was added to `.zpreztorc` in 4f19700919c8ebbaf75755fc0d03716d13183f49 but forgot to add it here.
2017-08-29 22:00:41 +00:00
'line' \
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
'cursor' \
'root'
```
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
[#52] Add zstyles to configure syntax-highlighting
2012-12-23 20:50:12 +00:00
### Highlighting Styles
Each syntax highlighter defines styles used to highlight tokens.
To highlight, for example, builtins, commands, and functions in blue instead of
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
green, add the following to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[#52] Add zstyles to configure syntax-highlighting
2012-12-23 20:50:12 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:syntax-highlighting' styles \
'builtin' 'bg=blue' \
'command' 'bg=blue' \
'function' 'bg=blue'
```
[#52] Add zstyles to configure syntax-highlighting
2012-12-23 20:50:12 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Authors
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
_The authors of this module should be contacted via the [issue tracker][5]._
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[Fix #118] Add documentation for syntax-highlighting
2012-06-14 21:24:40 +00:00
[1]: https://github.com/zsh-users/zsh-syntax-highlighting
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
[2]: ../history-substring-search#readme
general: Clarify relative ordering of modules in docs
2021-07-03 17:26:46 +00:00
[3]: ../autosuggestions#readme
[4]: https://github.com/zsh-users/zsh-syntax-highlighting/tree/master/highlighters
[5]: https://github.com/sorin-ionescu/prezto/issues