Skip to content

Commit fec4bcc

Browse files
committed
feat: add zellij-cb plugin and restructure plugin examples
1 parent 0b39db2 commit fec4bcc

6 files changed

+77
-63
lines changed

docs/src/SUMMARY.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Summary
22

33
- [Introduction](./introduction.md)
4-
- [Installation](./installation.md)
5-
- [Overview](./overview.md)
6-
- [Integration](./integration.md)
7-
- [FAQ](./faq.md)
4+
- [Installation](./installation.md)
5+
- [Overview](./overview.md)
6+
- [Integration](./integration.md)
7+
- [FAQ](./faq.md)
88
- [Commands](./commands.md)
99
- [Configuration](./configuration.md)
1010
- [Options](./options.md)
@@ -23,12 +23,12 @@
2323
- [Zellij Edit](./zellij-edit.md)
2424
- [Zellij Action](./cli-actions.md)
2525
- [Layouts](./layouts.md)
26-
- [Creating a Layout](./creating-a-layout.md)
27-
- [Swap Layouts](./swap-layouts.md)
28-
- [Including Configuration in Layouts](./layouts-with-config.md)
29-
- [Examples](./layout-examples.md)
30-
- [Migrating from old YAML layouts](./migrating-yaml-layouts.md)
31-
- [Plugins](./plugins.md)
26+
- [Creating a Layout](./creating-a-layout.md)
27+
- [Swap Layouts](./swap-layouts.md)
28+
- [Including Configuration in Layouts](./layouts-with-config.md)
29+
- [Examples](./layout-examples.md)
30+
- [Migrating from old YAML layouts](./migrating-yaml-layouts.md)
31+
- [Plugins](./plugins.md)
3232
- [Status of the Plugin System](./plugin-system-status.md)
3333
- [Loading Plugins](./plugin-loading.md)
3434
- [Plugin API](./plugin-api.md)
@@ -45,6 +45,9 @@
4545
- [Rendering a UI](./plugin-ui-rendering.md)
4646
- [Upgrading and Backwards Compatibility](./plugin-upgrading.md)
4747
- [Example Plugins](./plugin-examples.md)
48+
- [Bar Plugins](./plugin-examples-bars.md)
49+
- [Navigation Plugins](./plugin-examples-navigation.md)
50+
- [Other Plugins](./plugin-examples-miscellaneous.md)
4851
- [Developing a Plugin in Other Languages](./plugin-other-languages.md)
4952
- [Plugin Upgrade Guide for version 0.38.0](./plugin-upgrade-0.38.0.md)
5053
- [Compatibility](./compatibility.md)

docs/src/plugin-examples-bars.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Bar plugins
2+
3+
### [zjstatus](https://github.com/dj95/zjstatus)
4+
5+
![zjstatus preview](/img/zjstatus-preview.png)
6+
7+
[zjstatus](https://github.com/dj95/zjstatus) is a highly customizable status bar for Zellij. It has various widgets that can be styled to your liking, including such niceties as a system clock and even the ability to remove pane frames if there's only one pane on screen.
8+
9+
### [zellij-cb](https://github.com/ndavd/zellij-cb)
10+
11+
![zellij-cb preview](/img/zellij-cb-preview.png)
12+
13+
[zellij-cb](https://github.com/ndavd/zellij-cb) is a bar plugin for Zellij with compactability in mind which displays the project you're currently on. It also supports user configuration for colors and default tab names.
+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Miscellaneous plugins
2+
3+
### [jbz](https://github.com/nim65s/jbz)
4+
![jbz preview](/video/jbz-preview.gif)
5+
6+
[jbz](https://github.com/nim65s/jbz) simply spawn all your [just](https://github.com/casey/just) commands wrapped
7+
in [bacon](https://github.com/Canop/bacon), each one in a new pane.
8+
9+
### [Monocle](https://github.com/imsnif/monocle)
10+
![Monocle preview](/video/monocle-preview.gif)
11+
12+
[Monocle](https://github.com/imsnif/monocle) is a fuzzy finder for file names and their contents.
13+
14+
#### It can
15+
- Open results in your `$EDITOR` (scrolled to the correct line), as floating or tiled panes.
16+
- Open a new terminal pane to the location of the file, as a floating or tiled pane.
17+
- Ignore hidden files and respect your `.gitignore`.
18+
19+
If you press `ESC` or `Ctrl c`, it will hide itself until you call it again.
20+
21+
### [Multitask](https://github.com/imsnif/multitask)
22+
23+
![multitask plugin preview](/img/multitask-preview.png)
24+
25+
This Zellij plugin is a "mini-ci". It allows you to specify commands that will run in parallel, keeping track of completed commands and their exit status. Only progressing to the next step if all the commands in the previous step succeeded.
26+
27+
Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue.
+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Navigation plugins
2+
3+
### [harpoon](https://github.com/Nacho114/harpoon)
4+
5+
![harpoon preview](/video/harpoon-preview.gif)
6+
7+
[harpoon](https://github.com/Nacho114/harpoon) enables quick navigation to your favorite panes.
8+
You can use `a` to add the current pane to your harpoon list. You can navigate harpoon using `Up`,
9+
`Down`, or using vim navigation. To go to the pane you just press `Enter`.
10+
11+
### [room](https://github.com/rvcas/room)
12+
13+
![room preview](/video/room-preview.gif)
14+
15+
[room](https://github.com/rvcas/room) is for quickly searching and switching between tabs.
16+
You can use `Tab`, `Up`, or `Down` to cycle through your tab list and then press `Enter` to switch
17+
to the selected tab. You can start typing to filter the tab list and you use `Esc` or `Ctrl + c` to exit.
18+
19+
### [zellij-forgot](https://github.com/karimould/zellij-forgot)
20+
21+
![zellij-forgot](/img/forgot-preview.gif)
22+
23+
[zellij-forgot](https://github.com/karimould/zellij-forgot) is a plugin to quickly help you access and search through a customizable list of items. Can't remember your keybindings? Zellij-forgot can help you. Struggling to recall the names of all your cats? Zellij-forgot's got you covered!

docs/src/plugin-examples.md

+1-53
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,3 @@
11
# Example Plugins
22

3-
### [harpoon](https://github.com/Nacho114/harpoon)
4-
5-
![harpoon preview](/video/harpoon-preview.gif)
6-
7-
[harpoon](https://github.com/Nacho114/harpoon) enables quick navigation to your favorite panes.
8-
You can use `a` to add the current pane to your harpoon list. You can navigate harpoon using `Up`,
9-
`Down`, or using vim navigation. To go to the pane you just press `Enter`.
10-
11-
### [jbz](https://github.com/nim65s/jbz)
12-
![jbz preview](/video/jbz-preview.gif)
13-
14-
[jbz](https://github.com/nim65s/jbz) simply spawn all your [just](https://github.com/casey/just) commands wrapped
15-
in [bacon](https://github.com/Canop/bacon), each one in a new pane.
16-
17-
### [Monocle](https://github.com/imsnif/monocle)
18-
![Monocle preview](/video/monocle-preview.gif)
19-
20-
[Monocle](https://github.com/imsnif/monocle) is a fuzzy finder for file names and their contents.
21-
22-
#### It can
23-
- Open results in your `$EDITOR` (scrolled to the correct line), as floating or tiled panes.
24-
- Open a new terminal pane to the location of the file, as a floating or tiled pane.
25-
- Ignore hidden files and respect your `.gitignore`.
26-
27-
If you press `ESC` or `Ctrl c`, it will hide itself until you call it again.
28-
29-
### [Multitask](https://github.com/imsnif/multitask)
30-
31-
![multitask plugin preview](/img/multitask-preview.png)
32-
33-
This Zellij plugin is a "mini-ci". It allows you to specify commands that will run in parallel, keeping track of completed commands and their exit status. Only progressing to the next step if all the commands in the previous step succeeded.
34-
35-
Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue.
36-
37-
### [room](https://github.com/rvcas/room)
38-
39-
![room preview](/video/room-preview.gif)
40-
41-
[room](https://github.com/rvcas/room) is for quickly searching and switching between tabs.
42-
You can use `Tab`, `Up`, or `Down` to cycle through your tab list and then press `Enter` to switch
43-
to the selected tab. You can start typing to filter the tab list and you use `Esc` or `Ctrl + c` to exit.
44-
45-
### [zellij-forgot](https://github.com/karimould/zellij-forgot)
46-
47-
![zellij-forgot](/img/forgot-preview.gif)
48-
49-
[zellij-forgot](https://github.com/karimould/zellij-forgot) is a plugin to quickly help you access and search through a customizable list of items. Can't remember your keybindings? Zellij-forgot can help you. Struggling to recall the names of all your cats? Zellij-forgot's got you covered!
50-
51-
### [zjstatus](https://github.com/dj95/zjstatus)
52-
53-
![zjstatus preview](/img/zjstatus-preview.png)
54-
55-
[zjstatus](https://github.com/dj95/zjstatus) is a highly customizable status bar for Zellij. It has various widgets that can be styled to your liking, including such niceties as a system clock and even the ability to remove pane frames if there's only one pane on screen.
3+
The community has done fantastic plugins. Checkout the various subsections.

static/img/zellij-cb-preview.png

4.41 KB
Loading

0 commit comments

Comments
 (0)