Merge pull request #203 from Nacho114/harpoon_plugin

plugin-examples: added harpoon
zellij-org · Jul 28, 2023 · 568bd4d · 568bd4d
2 parents eccd3e1 + dbd62aa
commit 568bd4d
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 18 deletions.
diff --git a/docs/src/plugin-examples.md b/docs/src/plugin-examples.md
@@ -1,5 +1,13 @@
 # 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)
 

diff --git a/static/documentation/plugin-examples.html b/static/documentation/plugin-examples.html
@@ -4,8 +4,10 @@
         <!-- Book generated using mdBook -->
         <meta charset="UTF-8">
         <title>Example Plugins - Zellij User Guide</title>
+
+
         <!-- Custom HTML head -->
-        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+
         <meta name="description" content="">
         <meta name="viewport" content="width=device-width, initial-scale=1">
         <meta name="theme-color" content="#ffffff" />
@@ -16,25 +18,29 @@
         <link rel="stylesheet" href="css/general.css">
         <link rel="stylesheet" href="css/chrome.css">
         <link rel="stylesheet" href="css/print.css" media="print">
+
         <!-- Fonts -->
         <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
         <link rel="stylesheet" href="fonts/fonts.css">
+
         <!-- Highlight.js Stylesheets -->
         <link rel="stylesheet" href="highlight.css">
         <link rel="stylesheet" href="tomorrow-night.css">
         <link rel="stylesheet" href="ayu-highlight.css">
 
         <!-- Custom theme stylesheets -->
+
     </head>
     <body>
+    <div id="body-container">
         <!-- Provide site root to javascript -->
-        <script type="text/javascript">
+        <script>
             var path_to_root = "";
             var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
         </script>
 
         <!-- Work around some values being stored in localStorage wrapped in quotes -->
-        <script type="text/javascript">
+        <script>
             try {
                 var theme = localStorage.getItem('mdbook-theme');
                 var sidebar = localStorage.getItem('mdbook-sidebar');
@@ -50,7 +56,7 @@
         </script>
 
         <!-- Set the theme before any content is loaded, prevents flash -->
-        <script type="text/javascript">
+        <script>
             var theme;
             try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
             if (theme === null || theme === undefined) { theme = default_theme; }
@@ -62,12 +68,14 @@
         </script>
 
         <!-- Hide / unhide sidebar before it is displayed -->
-        <script type="text/javascript">
+        <script>
             var html = document.querySelector('html');
-            var sidebar = 'hidden';
+            var sidebar = null;
             if (document.body.clientWidth >= 1080) {
                 try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
                 sidebar = sidebar || 'visible';
+            } else {
+                sidebar = 'hidden';
             }
             html.classList.remove('sidebar-visible');
             html.classList.add("sidebar-" + sidebar);
@@ -83,7 +91,7 @@
         <div id="page-wrapper" class="page-wrapper">
 
             <div class="page">
-                <div id="menu-bar-hover-placeholder"></div>
+                                <div id="menu-bar-hover-placeholder"></div>
                 <div id="menu-bar" class="menu-bar sticky bordered">
                     <div class="left-buttons">
                         <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
@@ -93,7 +101,7 @@
                             <i class="fa fa-paint-brush"></i>
                         </button>
                         <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
-                            <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
                             <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
@@ -110,6 +118,7 @@ <h1 class="menu-title">Zellij User Guide</h1>
                         <a href="print.html" title="Print this book" aria-label="Print this book">
                             <i id="print-button" class="fa fa-print"></i>
                         </a>
+
                     </div>
                 </div>
 
@@ -123,8 +132,9 @@ <h1 class="menu-title">Zellij User Guide</h1>
                         </ul>
                     </div>
                 </div>
+
                 <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
-                <script type="text/javascript">
+                <script>
                     document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
                     document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
                     Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
@@ -135,6 +145,11 @@ <h1 class="menu-title">Zellij User Guide</h1>
                 <div id="content" class="content">
                     <main>
                         <h1 id="example-plugins"><a class="header" href="#example-plugins">Example Plugins</a></h1>
+<h3 id="harpoon"><a class="header" href="#harpoon"><a href="https://github.com/Nacho114/harpoon">harpoon</a></a></h3>
+<p><img src="/video/harpoon-preview.gif" alt="harpoon preview" /></p>
+<p><a href="https://github.com/Nacho114/harpoon">harpoon</a> enables quick navigation to your favorite panes. 
+You can use <code>a</code> to add the current pane to your harpoon list. You can navigate harpoon using <code>Up</code>,
+<code>Down</code>, or using vim navigation. To go to the pane you just press <code>Enter</code>.</p>
 <h3 id="jbz"><a class="header" href="#jbz"><a href="https://github.com/nim65s/jbz">jbz</a></a></h3>
 <p><img src="/video/jbz-preview.gif" alt="jbz preview" /></p>
 <p><a href="https://github.com/nim65s/jbz">jbz</a> simply spawn all your <a href="https://github.com/casey/just">just</a> commands wrapped
@@ -166,9 +181,11 @@ <h3 id="room"><a class="header" href="#room"><a href="https://github.com/rvcas/r
                             <a rel="prev" href="plugin-upgrading.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                                 <i class="fa fa-angle-left"></i>
                             </a>
+
                             <a rel="next" href="plugin-other-languages.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                 <i class="fa fa-angle-right"></i>
                             </a>
+
                         <div style="clear: both"></div>
                     </nav>
                 </div>
@@ -178,23 +195,33 @@ <h3 id="room"><a class="header" href="#room"><a href="https://github.com/rvcas/r
                     <a rel="prev" href="plugin-upgrading.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
                         <i class="fa fa-angle-left"></i>
                     </a>
+
                     <a rel="next" href="plugin-other-languages.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                         <i class="fa fa-angle-right"></i>
                     </a>
             </nav>
 
         </div>
 
-        <script type="text/javascript">
+
+
+
+        <script>
             window.playground_copyable = true;
         </script>
-        <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
-        <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="highlight.js" type="text/javascript" charset="utf-8"></script>
-        <script src="book.js" type="text/javascript" charset="utf-8"></script>
+
+
+        <script src="elasticlunr.min.js"></script>
+        <script src="mark.min.js"></script>
+        <script src="searcher.js"></script>
+
+        <script src="clipboard.min.js"></script>
+        <script src="highlight.js"></script>
+        <script src="book.js"></script>
 
         <!-- Custom JS scripts -->
+
+
+    </div>
     </body>
 </html>
diff --git a/static/documentation/print.html b/static/documentation/print.html
@@ -2702,6 +2702,11 @@ <h2 id="registering-a-plugin"><a class="header" href="#registering-a-plugin">Reg
 <p>Since Zellij plugins using <a href="./plugin-lifecycle.html"><code>zellij-tile</code></a> rely on shared data structures, currently one would need to compile a plugin against the corresponding <code>zellij-tile</code> package of the zellij version it is installed on.</p>
 <p>The Zellij maintainers are aware this is an inconvenient and undesired scenario and are working on a more robust solution.</p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="example-plugins"><a class="header" href="#example-plugins">Example Plugins</a></h1>
+<h3 id="harpoon"><a class="header" href="#harpoon"><a href="https://github.com/Nacho114/harpoon">harpoon</a></a></h3>
+<p><img src="/video/harpoon-preview.gif" alt="harpoon preview" /></p>
+<p><a href="https://github.com/Nacho114/harpoon">harpoon</a> enables quick navigation to your favorite panes. 
+You can use <code>a</code> to add the current pane to your harpoon list. You can navigate harpoon using <code>Up</code>,
+<code>Down</code>, or using vim navigation. To go to the pane you just press <code>Enter</code>.</p>
 <h3 id="jbz"><a class="header" href="#jbz"><a href="https://github.com/nim65s/jbz">jbz</a></a></h3>
 <p><img src="/video/jbz-preview.gif" alt="jbz preview" /></p>
 <p><a href="https://github.com/nim65s/jbz">jbz</a> simply spawn all your <a href="https://github.com/casey/just">just</a> commands wrapped
@@ -2720,6 +2725,11 @@ <h3 id="multitask"><a class="header" href="#multitask"><a href="https://github.c
 <p><img src="/img/multitask-preview.png" alt="multitask plugin preview" /></p>
 <p>This Zellij plugin is a &quot;mini-ci&quot;. 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.</p>
 <p>Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue.</p>
+<h3 id="room"><a class="header" href="#room"><a href="https://github.com/rvcas/room">room</a></a></h3>
+<p><img src="/video/room-preview.gif" alt="room preview" /></p>
+<p><a href="https://github.com/rvcas/room">room</a> is for quickly searching and switching between tabs.
+You can use <code>Tab</code>, <code>Up</code>, or <code>Down</code> to cycle through your tab list and then press <code>Enter</code> to switch
+to the selected tab. You can start typing to filter the tab list and you use <code>Esc</code> or <code>Ctrl + c</code> to exit.</p>
 <div style="break-before: page; page-break-before: always;"></div><h1 id="developing-a-plugin-in-other-languages"><a class="header" href="#developing-a-plugin-in-other-languages">Developing a Plugin in Other Languages</a></h1>
 <p>Here's a list of other SDKs for developing Zellij plugins in languages other than Rust:</p>
 <ol>

diff --git a/static/documentation/searchindex.js b/static/documentation/searchindex.js
diff --git a/static/documentation/searchindex.json b/static/documentation/searchindex.json
diff --git a/static/video/harpoon-preview.gif b/static/video/harpoon-preview.gif