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

89 lines
3.4 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
# Spectrum
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +00:00
Provides for easier use of 256 colors and effects.
Fix broken link to 256 color formatting blogpost Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-08-25 15:14:51 +00:00
To learn more about text formatting, read [A Guide to 256 Color Codes][1].
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +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
## Variables
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +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
- `BG` provides background colors.
- `FG` provides foreground colors.
- `FX` provides effects.
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +00:00
### Background and Foreground
Terminals support 8, 16, 88, and 256 colors. Check if a terminal supports 256
colors with `tput colors` before use.
The following colors are supported.
- 0 to 255
- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
### Effects
Though there are many effects, most terminals support at least bold formatting.
**Not all effects work on all terminals; use them sparingly.**
| Enable | Disable |
| ------------------------- | ---------------------------- |
| | none |
| | normal |
| bold | no-bold |
| faint | no-faint |
| standout | no-standout |
| underline | no-underline |
| blink | no-blink |
| fast-blink | no-fast-blink |
| reverse | no-reverse |
| conceal | no-conceal |
| strikethrough | no-strikethrough |
| gothic | no-gothic |
| double-underline | no-double-underline |
| proportional | no-proportional |
| overline | no-overline |
| | |
| | no-border |
| border-rectangle | no-border-rectangle |
| border-circle | no-border-circle |
| | |
| | no-ideogram-marking |
| underline-or-right | no-underline-or-right |
| double-underline-or-right | no-double-underline-or-right |
| overline-or-left | no-overline-or-left |
| double-overline-or-left | no-double-overline-or-left |
| stress | no-stress |
| | |
| | font-default |
| font-first | no-font-first |
| font-second | no-font-second |
| font-third | no-font-third |
| font-fourth | no-font-fourth |
| font-fifth | no-font-fifth |
| font-sixth | no-font-sixth |
| font-seventh | no-font-seventh |
Fix a typo s/eigth/eighth/
2021-04-03 17:42:28 +00:00
| font-eighth | no-font-eighth |
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +00:00
| font-ninth | no-font-ninth |
### Plain Text
Use `$BG[none]`, `$FG[none]`, or `$FX[none]` to turn off formatting.
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 #116] Add documentation for spectrum
2012-09-11 00:05:10 +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
_The authors of this module should be contacted via the [issue tracker][2]._
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +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
- [P.C. Shyamshankar](https://github.com/sykora)
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +00:00
Fix broken link to 256 color formatting blogpost Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>
2014-08-25 15:14:51 +00:00
[1]: http://lucentbeing.com/writing/archives/a-guide-to-256-color-codes/
[Fix #116] Add documentation for spectrum
2012-09-11 00:05:10 +00:00
[2]: https://github.com/sorin-ionescu/prezto/issues