Document the fact that a "sync" mode exists in tab commands

.envrc

@@ -0,0 +1 @@
+use_flake

.gitignore

@@ -1,5 +1,7 @@
-.envrc
 .direnv/
+result/
+result
+/*.png
 
 # Created by https://www.toptal.com/developers/gitignore/api/hugo
 # Edit at https://www.toptal.com/developers/gitignore?templates=hugo

config.toml

@@ -175,6 +175,11 @@ disableHugoGeneratorInject = false
     identifier = "news"
     name       = "News"
     url        = "news/"
+  [[menu.main]]
+    weight = 2
+    identifier = "roadmap"
+    name       = "Roadmap"
+    url        = "roadmap/"
   [[menu.main]]
     weight = 3
     identifier = "screenshots"

content/news/edit-scrollback-compact.md

@@ -0,0 +1,66 @@
+---
+author: "Aram Drevekenin"
+authorlink: "https://twitter.com/im_snif"
+date: 2022-06-08
+linktitle: "Zellij 0.30.0: use your $EDITOR to search and save your scrollback"
+type:
+- post
+- posts
+title: "Zellij 0.30.0: use your $EDITOR to search and save your scrollback"
+images: ["/img/floating-panes-preview.png"]
+description: "The latest Zellij version introduces the ability to edit your scrollback with your $EDITOR, a compact layout and much more!"
+alttext: "An image of the Zellij terminal multiplexer"
+weight: 10
+---
+
+We just released [Zellij 0.30.0](https://github.com/zellij-org/zellij/releases/tag/v0.30.0), which adds a few very exciting features.
+
+The new release is available through crates.io with a `cargo install zellij`, a prebuilt binary can be downloaded directly from the release page, or you can check our [third party release page](https://github.com/zellij-org/zellij/blob/main/THIRD_PARTY_INSTALL.md) to see if it's already available for your distro.
+
+Starting this release, you can also try Zellij without installing it (check out the main page: [https://zellij.dev](https://zellij.dev)).
+
+So what's new?
+
+### Edit your scrollback in your default $EDITOR
+Imagine you're working in a session and you'd like to:
+1. Save all your scrollback for later for reference or to send to a friend
+2. Copy parts of the scrollback and save them in a different file
+3. Search through the scrollback just like you would through a normal file
+
+Starting with this version, you can issue a `Ctrl + <s> + <e>` and Zellij will open the editor you have defined in `$EDITOR` or `$VISUAL` (eg. /usr/bin/vim) in place instead of your pane.
+There you can edit the file, save it, copy from it or search inside it. Once you close the editor (or close the pane normally with `Ctrl + <p> + <x>`), you'll be back in your pane where you started.
+
+{{< video "/video/edit-buffer-demo.mp4" "my-5" >}}
+
+### Compact layout
+
+One of the things we hear a lot from users is that while they really like the discoverability of the Zellij UI, after a while once they've learned the shortcuts it takes up too much screen real-estate.
+Starting this version, Zellij also includes a "compact" layout. You can get it by starting Zellij with:
+
+```
+zellij --layout compact
+```
+
+This version of our UI includes just one bar with the session name, tabs and the current input mode.
+
+{{<figure src="/img/compact-bar.png" class="center">}}
+
+If you'd like even more screen space, you can always additionally disable the pane frames. At run time using `Ctrl + <p> + <z>` or in the config using `pane-frames: false`.
+
+### Handy Tips at Runtime
+
+One of the cool things about Zellij is that a lot of its features are community driven. Contributed not as part of an official roadmap, but in order to scratch an itch for one or more of its users. As such, these can sometimes be a little challenging to discover. No matter how much documentation we add, there is no substitute to finding out about these extra features from the app itself.
+
+Starting this version - if you do choose to load the full UI with the status bar - you'll see a random tip on the bottom line to hopefully help brighten up your workflow.
+
+{{<figure src="/img/tip-preview.png" class="center">}}
+
+#### [And there's lots more in this version!](https://github.com/zellij-org/zellij/releases/tag/v0.30.0)
+
+### So what's next for Zellij?
+
+We've recently published a roadmap for the near to medium future. You can check it out [here](https://zellij.dev/roadmap).
+
+Zellij is a volunteer not-for-profit open-source project. Most of our maintainers have started out contributing features and fixing bugs. If one of the features in the roadmap interests you, we'd be very happy to guide you through implementing it. Feel free to drop by one of our chat servers (links in the [README](https://github.com/zellij-org/zellij)) or ask for help in the issue directly.
+
+Happy terminal multiplexing!

content/roadmap.md

@@ -0,0 +1,12 @@
+---
+title: "Zellij Roadmap"
+---
+
+Presented here is the project roadmap, divided into three main sections.
+
+These are issues that are either being actively worked on or are planned for the near future.
+
+Each issue links to our repository where you can find further details about it.
+
+{{< roadmap >}}
+{{< /roadmap >}}

docs/src/SUMMARY.md

@@ -4,20 +4,23 @@
     - [Installation](./installation.md)
     - [Overview](./overview.md)
     - [Integration](./integration.md)
+    - [FAQ](./faq.md)
 - [Commands](./commands.md)
 - [Configuration](./configuration.md)
   - [Options](./options.md)
   - [Configuring Keybindings](./keybindings.md)
     - [Modes](./keybindings-modes.md)
     - [Keys](./keybindings-keys.md)
-    - [Actions](./keybindings-actions.md)
     - [Examples](./keybindings-examples.md)
   - [Themes](./themes.md)
+    - [Theme Gallery](./theme-gallery.md)
+- [Actions](./actions.md)
 - [Layouts](./layouts.md)
     - [Templates](./layouts-templates.md)
 - [Plugins](./plugins.md)
   - [Overview](./plugin-overview.md)
   - [Developing a Plugin](./plugin-writing.md)
     - [Rust](./plugin-rust.md)
+    - [Zig](./plugin-zig.md)
     - [Other Languages](./plugin-other.md)
 - [Compatibility](./compatibility.md)

docs/src/keybindings-actions.md → docs/src/actions.md

@@ -1,5 +1,6 @@
 # Actions
 These are the actions that can be assigned to key sequences when [configuring keybindings](./keybindings.md).
+Or that can be invoked by the `zellij action` command.
 
 ## `Quit`
 Quit Zellij.
@@ -133,3 +134,8 @@ Write the specified bytes in the focused pane.
 ## `WriteChars: <characters>`
 Write the specified characters in the focused pane.
 
+## `DumpScreen: <path>`
+Dump the scrollback of the currently selected pane inside of a selected file.
+
+## `EditScrollback`
+Edit the scrollback buffer inside of your specified $EDITOR, or  $VISUAL.

docs/src/compatibility.md

@@ -21,6 +21,8 @@ Some Options:
 | apt               |fonts-powerline |
 | nix               |    nerdfonts   |
 
+Post installation the appropriate environment needs to be aware of the font.
+
 ## Alt button mapping on darwin systems:
 
 This can be mitigated individually on a terminal emulator level,

docs/src/faq.md

@@ -0,0 +1,39 @@
+# FAQ
+
+## Zellij overrides certain key combinations that I use for other apps, what can I do?
+As an "escape hatch" solution, you can lock the interface with `Ctrl + g` - at this point all keys will be sent to the focused pane.
+
+You could also [remap keys](./keybindings.md) to work around this problem.
+
+That being said, the maintainers are aware that this default set of keybindings is not an ideal solution. We tried to find a solution that would both be powerful, allowing few and memorable keypresses to be used for common actions, and also unobtrusive. Finding a solution that would do better in the latter while still maintaining the former is something we're actively thinking about and planning on changing in the future. If you have any thoughts, please do share them in an issue or in one of our chat servers.
+
+## The UI takes up too much space, what can I do about it?
+
+You can load the `compact` layout with `zellij --layout compact`.
+
+Additionally, you can disable pane frames either at runtime with `Ctrl + <p> + <z>` or through the [config](./configuration.md) with `pane_frames: false`.
+
+## I see broken characters in the default UI, how can I fix this?
+This means your default terminal font doesn't include some special characters used by Zellij. A safe bet would be to install and use a font from [nerdfonts](https://www.nerdfonts.com).
+
+If you don't want to install a new font, you can also load the simplified UI that doesn't use these characters, with:
+```
+zellij options --simplified-ui true
+```
+
+## How can I use floating panes?
+You can toggle showing/hiding floating panes with `Ctrl + <p> + <w>` (if no floating panes are open, one will be opened when they are shown).
+
+In this mode you can create additional windows as you would normally create panes (eg. with `Alt + <n>`). Move them with the mouse or the keyboard, and resize them as you would normally resize or move Zellij panes.
+
+You can also embed a floating pane with `Ctrl + <p> + <e>`, and float an embedded pane in the same way.
+
+## How can I sync input to multiple panes?
+You can toggle sync input to all panes in a tab with `Ctrl + <t> + <s>`. Then everything you type will be sent to all panes in the tab.
+
+## Editing the pane scrollbuffer with `ctrl + <s> + <e>` doesn't work, what's wrong?
+
+By default, Zellij looks for an editor defined in the `EDITOR` or `VISUAL` environment variables (in this order).
+Make sure one is set (eg. `export EDITOR=/usr/bin/vim`) before Zellij starts.
+Alternatively, you can set one in the Zellij [config](./configuration.md) using `scrollback-editor`.
+

docs/src/integration.md

@@ -58,7 +58,7 @@ The following environment variables can also be used in the provided script.
 
 ## List current sessions
 List current sessions, attach to a running session, or create a new one.
-Depends on `sk` & `bash`
+Depends on [`sk`](https://github.com/lotabout/skim) & `bash`
 
 ```
 #!/usr/bin/env bash

docs/src/keybindings-modes.md

@@ -10,7 +10,7 @@ It is intended to give users a workaround in case one of the default keybindings
 ## pane
 This mode includes instructions that manipulate the different panes. Eg. adding new panes, closing panes and moving the focused pane.
 ## tab
-This mode includes instructions that manipulate the different tabs. Eg. adding new tabs, closing tabs and moving the active tab.
+This mode includes instructions that manipulate the different tabs. Eg. adding new tabs, closing tabs, moving the active tab, and toggling a "sync" mode that sends text to all panes in the current tab.
 ## resize
 This mode allows the resizing of the focused pane.
 ## scroll

docs/src/layouts.md

@@ -4,18 +4,21 @@ These files can describe a layout of terminal panes and plugins that Zellij will
 To load a layout with Zellij:
 
 ```
-zellij --layout-path /path/to/your/layout_file.yaml
+zellij --layout /path/to/your/layout_file.yaml
 ```
 
 By default Zellij will load the `default.yaml` layout, that is found in the
 `layouts` directory (by default a subdirectory of the `config`
 directory [config/layouts]). Falling back to an internal default layout,
 if not found.
 Layouts residing in the default directory can be accessed as follows:
+
 ```
 zellij --layout [layout_name]
 ```
 
+The difference being: if a path (either absolute or relative) is supplied to `--layout`, it will load the layout from that path. If a bare name is supplied, it will load a built-in layout from the default directory.
+
 ## Example
 This file:
 ```yaml
@@ -118,6 +121,14 @@ run:
   command: {cmd: htop, args: ["-C"]}
 ```
 
+This can be used to open a pane in a specified directory by making use of your shell's `command` flag and `cd path/to/directory && <shell>`. The following command is **only** for `zsh`. It may work for other shells, but it is not guaranteed. Check your shell's documentation for how to use the command flag.
+
+Example:
+```
+run:
+  command: { cmd: zsh, args: ["-c", "cd ~/Documents/code/zellij && zsh"] }
+```
+
 ### `name: <name-of-the-tab>`
 This is an optional command that can be used to name the `tab` in the tab layout
 section. 
@@ -209,7 +220,5 @@ default_shell: fish
 ```
 
 
-
 ## Further examples
 Please take a look at the [default](https://github.com/zellij-org/zellij/tree/main/zellij-utils/assets/layouts) layouts that come with Zellij, or the layouts that reside in the [example](https://github.com/zellij-org/zellij/tree/main/example) directory for more complete layouts.
-

docs/src/options.md

@@ -9,6 +9,7 @@ Eg. `zellij options --simplified-ui true` is equivalent to `simplified_ui: true`
 |---------------|-------------------|:--------------:|------------|
 | default-mode  | default_mode      | normal         | The first mode on startup. |
 | default-shell | default_shell     | $SHELL         | The default shell.         |
+| default-layout | default_layout     | default         | The name of the default layout.        |
 | mouse-mode | mouse_mode     | true         | Enable mouse mode.         |
 | disable-mouse-mode | -     | false         | Disable mouse mode.         |
 | simplified-ui | simplified_ui     | false          | Request the Plugins to use a more compatible ui.  |
@@ -18,6 +19,10 @@ Eg. `zellij options --simplified-ui true` is equivalent to `simplified_ui: true`
 | theme         | theme             | default        | Switch to a theme configured under the `themes` section.  |
 | scroll-buffer-size| scroll_buffer_size | 10000 | The number of lines zellij stores for each pane in the scroll back buffer.|
 | _ | env | empty | A map of key value pairs for environment variables. |
+| copy-command | copy_command | _ | Command to execute when copying text, instead of using OSC52 (for example wl-copy, xclip, pbcopy). |
+| copy-clipboard | copy_clipboard | system | Destination selection buffer (x11/linux) for OSC52 copy, can be system or primary. |
+| copy-on-select | copy_on_select | true | Automatically copy when selecting text. |
+| scrollback-editor | scrollback_editor | - | Path to the editor to use to edit scrollback (eg. `/usr/bin/vim`) |
 
 
 

docs/src/plugin-writing.md

@@ -1,3 +1,3 @@
 # Developing a Plugin
 
-Currently we have a complete guide for developing plugins in [Rust](./plugin-rust.md) and plan to add more guides for other languages in the future. If you are feeling particularly brave, you can try to write plugins in another language today! The [Other Languages](./plugin-other.md) section will get you started.
+Currently we have a complete guide for developing plugins in [Rust](./plugin-rust.md) and in [Zig](./plugin-zig.md). We plan to add more guides for other languages in the future. If you are feeling particularly brave, you can try to write plugins in another language today! The [Other Languages](./plugin-other.md) section will get you started.