diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 6b2c5bf..d5155c4 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,10 +1,10 @@ # Summary - [Introduction](./introduction.md) - - [Installation](./installation.md) - - [Overview](./overview.md) - - [Integration](./integration.md) - - [FAQ](./faq.md) + - [Installation](./installation.md) + - [Overview](./overview.md) + - [Integration](./integration.md) + - [FAQ](./faq.md) - [Commands](./commands.md) - [Configuration](./configuration.md) - [Options](./options.md) @@ -23,12 +23,12 @@ - [Zellij Edit](./zellij-edit.md) - [Zellij Action](./cli-actions.md) - [Layouts](./layouts.md) - - [Creating a Layout](./creating-a-layout.md) - - [Swap Layouts](./swap-layouts.md) - - [Including Configuration in Layouts](./layouts-with-config.md) - - [Examples](./layout-examples.md) - - [Migrating from old YAML layouts](./migrating-yaml-layouts.md) -- [Plugins](./plugins.md) + - [Creating a Layout](./creating-a-layout.md) + - [Swap Layouts](./swap-layouts.md) + - [Including Configuration in Layouts](./layouts-with-config.md) + - [Examples](./layout-examples.md) + - [Migrating from old YAML layouts](./migrating-yaml-layouts.md) +- [Plugins](./plugins.md) - [Status of the Plugin System](./plugin-system-status.md) - [Loading Plugins](./plugin-loading.md) - [Plugin API](./plugin-api.md) @@ -45,6 +45,9 @@ - [Rendering a UI](./plugin-ui-rendering.md) - [Upgrading and Backwards Compatibility](./plugin-upgrading.md) - [Example Plugins](./plugin-examples.md) + - [Bar Plugins](./plugin-examples-bars.md) + - [Navigation Plugins](./plugin-examples-navigation.md) + - [Other Plugins](./plugin-examples-miscellaneous.md) - [Developing a Plugin in Other Languages](./plugin-other-languages.md) - [Plugin Upgrade Guide for version 0.38.0](./plugin-upgrade-0.38.0.md) - [Compatibility](./compatibility.md) diff --git a/docs/src/plugin-examples-bars.md b/docs/src/plugin-examples-bars.md new file mode 100644 index 0000000..96519c0 --- /dev/null +++ b/docs/src/plugin-examples-bars.md @@ -0,0 +1,13 @@ +# Bar plugins + +### [zjstatus](https://github.com/dj95/zjstatus) + +![zjstatus preview](/img/zjstatus-preview.png) + +[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. + +### [zellij-cb](https://github.com/ndavd/zellij-cb) + +![zellij-cb preview](/img/zellij-cb-preview.png) + +[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. diff --git a/docs/src/plugin-examples-miscellaneous.md b/docs/src/plugin-examples-miscellaneous.md new file mode 100644 index 0000000..29c56a5 --- /dev/null +++ b/docs/src/plugin-examples-miscellaneous.md @@ -0,0 +1,27 @@ +# Miscellaneous plugins + +### [jbz](https://github.com/nim65s/jbz) +![jbz preview](/video/jbz-preview.gif) + +[jbz](https://github.com/nim65s/jbz) simply spawn all your [just](https://github.com/casey/just) commands wrapped +in [bacon](https://github.com/Canop/bacon), each one in a new pane. + +### [Monocle](https://github.com/imsnif/monocle) +![Monocle preview](/video/monocle-preview.gif) + +[Monocle](https://github.com/imsnif/monocle) is a fuzzy finder for file names and their contents. + +#### It can +- Open results in your `$EDITOR` (scrolled to the correct line), as floating or tiled panes. +- Open a new terminal pane to the location of the file, as a floating or tiled pane. +- Ignore hidden files and respect your `.gitignore`. + +If you press `ESC` or `Ctrl c`, it will hide itself until you call it again. + +### [Multitask](https://github.com/imsnif/multitask) + +![multitask plugin preview](/img/multitask-preview.png) + +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. + +Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue. diff --git a/docs/src/plugin-examples-navigation.md b/docs/src/plugin-examples-navigation.md new file mode 100644 index 0000000..4dcc282 --- /dev/null +++ b/docs/src/plugin-examples-navigation.md @@ -0,0 +1,23 @@ +# Navigation plugins + +### [harpoon](https://github.com/Nacho114/harpoon) + +![harpoon preview](/video/harpoon-preview.gif) + +[harpoon](https://github.com/Nacho114/harpoon) enables quick navigation to your favorite panes. +You can use `a` to add the current pane to your harpoon list. You can navigate harpoon using `Up`, +`Down`, or using vim navigation. To go to the pane you just press `Enter`. + +### [room](https://github.com/rvcas/room) + +![room preview](/video/room-preview.gif) + +[room](https://github.com/rvcas/room) is for quickly searching and switching between tabs. +You can use `Tab`, `Up`, or `Down` to cycle through your tab list and then press `Enter` to switch +to the selected tab. You can start typing to filter the tab list and you use `Esc` or `Ctrl + c` to exit. + +### [zellij-forgot](https://github.com/karimould/zellij-forgot) + +![zellij-forgot](/img/forgot-preview.gif) + +[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! diff --git a/docs/src/plugin-examples.md b/docs/src/plugin-examples.md index fd619ba..0906d52 100644 --- a/docs/src/plugin-examples.md +++ b/docs/src/plugin-examples.md @@ -1,55 +1,3 @@ # Example Plugins -### [harpoon](https://github.com/Nacho114/harpoon) - -![harpoon preview](/video/harpoon-preview.gif) - -[harpoon](https://github.com/Nacho114/harpoon) enables quick navigation to your favorite panes. -You can use `a` to add the current pane to your harpoon list. You can navigate harpoon using `Up`, -`Down`, or using vim navigation. To go to the pane you just press `Enter`. - -### [jbz](https://github.com/nim65s/jbz) -![jbz preview](/video/jbz-preview.gif) - -[jbz](https://github.com/nim65s/jbz) simply spawn all your [just](https://github.com/casey/just) commands wrapped -in [bacon](https://github.com/Canop/bacon), each one in a new pane. - -### [Monocle](https://github.com/imsnif/monocle) -![Monocle preview](/video/monocle-preview.gif) - -[Monocle](https://github.com/imsnif/monocle) is a fuzzy finder for file names and their contents. - -#### It can -- Open results in your `$EDITOR` (scrolled to the correct line), as floating or tiled panes. -- Open a new terminal pane to the location of the file, as a floating or tiled pane. -- Ignore hidden files and respect your `.gitignore`. - -If you press `ESC` or `Ctrl c`, it will hide itself until you call it again. - -### [Multitask](https://github.com/imsnif/multitask) - -![multitask plugin preview](/img/multitask-preview.png) - -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. - -Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue. - -### [room](https://github.com/rvcas/room) - -![room preview](/video/room-preview.gif) - -[room](https://github.com/rvcas/room) is for quickly searching and switching between tabs. -You can use `Tab`, `Up`, or `Down` to cycle through your tab list and then press `Enter` to switch -to the selected tab. You can start typing to filter the tab list and you use `Esc` or `Ctrl + c` to exit. - -### [zellij-forgot](https://github.com/karimould/zellij-forgot) - -![zellij-forgot](/img/forgot-preview.gif) - -[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! - -### [zjstatus](https://github.com/dj95/zjstatus) - -![zjstatus preview](/img/zjstatus-preview.png) - -[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. +The community has done fantastic plugins. Checkout the various subsections. diff --git a/static/img/zellij-cb-preview.png b/static/img/zellij-cb-preview.png new file mode 100644 index 0000000..535c41c Binary files /dev/null and b/static/img/zellij-cb-preview.png differ