Skip to content

Commit 24711da

Browse files
committed
docs: update formatting
1 parent e92a4ef commit 24711da

File tree

1 file changed

+46
-17
lines changed

1 file changed

+46
-17
lines changed

README.md

Lines changed: 46 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,17 @@ set -g @tmux2k-yellow '#f8c800' # change yellow color
109109
110110
### 🧩 Available Plugins
111111

112-
1. `bandwidth`: Show network bandwidth usage
112+
#### 1. `bandwidth`
113+
114+
Show network bandwidth usage
113115

114116
- `tmux2k-bandwidth-network-name`: Network interface to track bandwidth of, default: `en0`
115117
- `tmux2k-bandwidth-up-icon`: Icon for bandwidth upload usage, default: ``
116118
- `tmux2k-bandwidth-down-icon`: Icon for bandwidth download usage, default: ``
117119

118-
2. `battery`: Show battery stats and percentage
120+
#### 2. `battery`
121+
122+
Show battery stats and percentage
119123

120124
- `tmux2k-battery-charging-icon`: Icon for charging status, default: ``
121125
- `tmux2k-battery-missing-icon`: Icon for missing battery, default: `󱉝`
@@ -125,16 +129,22 @@ set -g @tmux2k-yellow '#f8c800' # change yellow color
125129
- `tmux2k-battery-percentage-3`: Icon for 75-90% battery, default: ``
126130
- `tmux2k-battery-percentage-4`: Icon for 90-100% battery, default: ``
127131

128-
3. `cpu`: Show CPU usage information
132+
#### 3. `cpu`
133+
134+
Show CPU usage information
129135

130136
- `tmux2k-cpu-icon`: Icon for CPU usage, default: ``
131137
- `tmux2k-cpu-display-load`: Control CPU load display, default: `false`
132138

133-
4. `cwd`: Show current working directory
139+
#### 4. `cwd`
140+
141+
Show current working directory
134142

135143
- `tmux2k-cwd-icon`: Icon for directory, default: ``
136144

137-
5. `git`: Show Git branch and status information
145+
#### 5. `git`
146+
147+
Show Git branch and status information
138148

139149
- `tmux2k-git-display-status`: Control git status display, default: `false`
140150
- `tmux2k-git-added-icon`: Icon for added files, default: ``
@@ -145,50 +155,69 @@ set -g @tmux2k-yellow '#f8c800' # change yellow color
145155
- `tmux2k-git-diff-icon`: Icon for differences, default: ``
146156
- `tmux2k-git-no-repo-icon`: Icon for no repository, default: ``
147157

148-
6. `gpu`: Show GPU usage information
158+
#### 6. `gpu`
159+
160+
Show GPU usage information
149161

150162
- `tmux2k-gpu-icon`: Icon for GPU usage, default: ```
151163

152-
7. `network`: Show network status and statistics
164+
#### 7. `network`
165+
166+
Show network status and statistics
153167

154168
- `tmux2k-network-ethernet-icon`: Icon for Ethernet connection, default: `󰈀`
155169
- `tmux2k-network-wifi-icon`: Icon for Wi-Fi connection, default: ``
156170
- `tmux2k-network-offline-icon`: Icon for offline status, default: `󰌙`
157171

158-
8. `ping`: Show network ping statistics
159-
9. `pomodoro`: Shows pomodoro timer, needs [tmux-pomodoro-plus](https://github.com/olimorris/tmux-pomodoro-plus) (hit `prefix + p` to start)
160-
10. `ram`: Show RAM usage information
172+
#### 8. `ping`
173+
174+
Show network ping statistics
175+
176+
#### 9. `pomodoro`
177+
178+
Shows pomodoro timer, needs [tmux-pomodoro-plus](https://github.com/olimorris/tmux-pomodoro-plus) (hit `prefix + p` to start)
179+
180+
#### 10. `ram`
181+
182+
Show RAM usage information
161183

162184
- `tmux2k-ram-icon`: Icon for RAM usage, default: ``
163185

164-
11. `session`: Shows Current Session/Window with custom icon
186+
#### 11. `session`
187+
188+
Shows Current Session/Window with custom icon
165189

166190
- `tmux2k-session-format`: Format for Tmux session, default: `#S`
167191
- `tmux2k-session-icon`: Icon for Tmux session, default: ``
168192

169-
12. `time`: Show current time and date
193+
#### 12. `time`
194+
195+
Show current time and date
170196

171197
- `@tmux2k-time-format`: Sets the format for displaying the time. Default: `"%a %I:%M %p"`
172198
- `@tmux2k-time-icon`: Sets the icon for the time display. Default: ``
173199

174-
13. `weather`: Show weather information
200+
#### 13. `weather`
201+
202+
Show weather information
175203

176204
- `@tmux2k-weather-scale`: Scale to use for temperature. Default: `c`, options: `[c, f, k]`
177205
- `@tmux2k-weather-display-location`: Whether to show location name. Default: `true`
178206
- `@tmux2k-weather-location`: Fixed location for weather. Default: `""`
179207

180-
14. `window_list`: tmux window list
208+
#### 14. `window_list`
209+
210+
tmux window list
181211

182212
- `@tmux2k-window-list-left-sep`: Sets the left separator for the window list. Default: ``
183213
- `@tmux2k-window-list-right-sep`: Sets the right separator for the window list. Default: ``
184214
- `@tmux2k-window-list-alignment`: Sets the alignment of the window list. Default: `'absolute-centre'`
185215
- `@tmux2k-window-list-format`: Sets the format for the window list. Default: `'#I:#W'`
186-
- `@tmux2k-window-list-flags`: Enables or disables window flags in the window list. Default: `true`
187216
- `@tmux2k-window-list-compact`: Enables or disables compact mode for the window list. Default: `false`
188217

189-
To customize plugins, I'll highly recommend checking out their respective scripts in the [scripts](./scripts) folder.
190218

191-
#### Gemeral Plugin Config
219+
#### Gemeral Plugin Configs
220+
192221

193222
```bash
194223
# set the left and right plugin sections

0 commit comments

Comments
 (0)