IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-12-23 03:52:12 +03:00
Code Issues Projects Releases Wiki Activity

Update general variables

Ilan Cosman 2020-07-20 17:00:19 -07:00
parent 5719468a03
commit ed4cae456a
2 changed files with 36 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Configuration.md

@ -1,6 +1,6 @@
## Variable Naming
Tide variables that users are encouraged to modify begin with the string `tide_`. Thus all variables will be denoted as `example_variable` but will actually be `tide_example_variable`.
Variables in these sections will be denoted as `foo_bar` but will actually be `tide_[HEADER]_foo_bar`. Variables that do not conform to this standard will be written out in full.
See the following sections for variable names and descriptions.

46
General-Variables.md

@ -1,14 +1,38 @@
## General Variables
| Variable | Description |
| -------------------------------- | ------------------------------------- |
| tide_print_newline_before_prompt | print an empty line before the prompt |
| Variable | Description | Default |
| ------------------ | ------------------------------------------ | -------------------------------------------- |
| newline | add empty line before each prompt | true |
| left_prompt_items | order of the left prompt items to display | pwd git_prompt newline prompt_char |
| right_prompt_items | order of the right prompt items to display | status cmd_duration context jobs virtual_env |
## prompt_connection
### prompt_connection
| Variable | Description | Type |
| -------- | --------------------------------------------------------------------- | ------ |
| color | color of prompt connection | color |
| icon | repeated symbol that spans gap between left and right sides of prompt | string |
| Variable | Description | Default |
| ----------------------- | --------------------------------------------------------------------- | ------- |
| prompt_connection_color | color of prompt connection | 6C6C6C |
| prompt_connection_icon | repeated symbol that spans gap between left and right sides of prompt | ' ' |
## left_prompt
| Variable | Description | Type |
| ------------------------------- | --------------------------------------------------------- | ------- |
| items | order of items to print in the left prompt | list |
| pad_items | add spaces to the ends of each prompt item | boolean |
| item_separator_same_color | string to separate items with the same background color | string |
| item_separator_diff_color | string to separate items with different background colors | string |
| item_separator_same_color_color | color of the item_separator_same_color | color |
| prefix | string to put before the left prompt | string |
| suffix | string to put after the left prompt | string |
| frame_enabled | display the left prompt frame | boolean |
| frame_color | color of the left prompt frame | color |
## right_prompt
| Variable | Description | Type |
| ------------------------------- | --------------------------------------------------------- | ------- |
| items | order of items to print in the right prompt | list |
| pad_items | add spaces to the ends of each prompt item | boolean |
| item_separator_same_color | string to separate items with the same background color | string |
| item_separator_diff_color | string to separate items with different background colors | string |
| item_separator_same_color_color | color of the item_separator_same_color | color |
| prefix | string to put before the right prompt | string |
| suffix | string to put after the right prompt | string |
| frame_enabled | display the right prompt frame | boolean |
| frame_color | color of the right prompt frame | color |