Skip to content

Commit 568bd4d

Browse files
imsnifimsnif
authored
Merge pull request #203 from Nacho114/harpoon_plugin
plugin-examples: added harpoon
2 parents eccd3e1 + dbd62aa commit 568bd4d

File tree

6 files changed

+63
-18
lines changed

6 files changed

+63
-18
lines changed

‎docs/src/plugin-examples.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
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+
311
### [jbz](https://github.com/nim65s/jbz)
412
![jbz preview](/video/jbz-preview.gif)
513

‎static/documentation/plugin-examples.html

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
<!-- Book generated using mdBook -->
55
<meta charset="UTF-8">
66
<title>Example Plugins - Zellij User Guide</title>
7+
8+
79
<!-- Custom HTML head -->
8-
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
10+
911
<meta name="description" content="">
1012
<meta name="viewport" content="width=device-width, initial-scale=1">
1113
<meta name="theme-color" content="#ffffff" />
@@ -16,25 +18,29 @@
1618
<link rel="stylesheet" href="css/general.css">
1719
<link rel="stylesheet" href="css/chrome.css">
1820
<link rel="stylesheet" href="css/print.css" media="print">
21+
1922
<!-- Fonts -->
2023
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
2124
<link rel="stylesheet" href="fonts/fonts.css">
25+
2226
<!-- Highlight.js Stylesheets -->
2327
<link rel="stylesheet" href="highlight.css">
2428
<link rel="stylesheet" href="tomorrow-night.css">
2529
<link rel="stylesheet" href="ayu-highlight.css">
2630

2731
<!-- Custom theme stylesheets -->
32+
2833
</head>
2934
<body>
35+
<div id="body-container">
3036
<!-- Provide site root to javascript -->
31-
<script type="text/javascript">
37+
<script>
3238
var path_to_root = "";
3339
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
3440
</script>
3541

3642
<!-- Work around some values being stored in localStorage wrapped in quotes -->
37-
<script type="text/javascript">
43+
<script>
3844
try {
3945
var theme = localStorage.getItem('mdbook-theme');
4046
var sidebar = localStorage.getItem('mdbook-sidebar');
@@ -50,7 +56,7 @@
5056
</script>
5157

5258
<!-- Set the theme before any content is loaded, prevents flash -->
53-
<script type="text/javascript">
59+
<script>
5460
var theme;
5561
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
5662
if (theme === null || theme === undefined) { theme = default_theme; }
@@ -62,12 +68,14 @@
6268
</script>
6369

6470
<!-- Hide / unhide sidebar before it is displayed -->
65-
<script type="text/javascript">
71+
<script>
6672
var html = document.querySelector('html');
67-
var sidebar = 'hidden';
73+
var sidebar = null;
6874
if (document.body.clientWidth >= 1080) {
6975
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
7076
sidebar = sidebar || 'visible';
77+
} else {
78+
sidebar = 'hidden';
7179
}
7280
html.classList.remove('sidebar-visible');
7381
html.classList.add("sidebar-" + sidebar);
@@ -83,7 +91,7 @@
8391
<div id="page-wrapper" class="page-wrapper">
8492

8593
<div class="page">
86-
<div id="menu-bar-hover-placeholder"></div>
94+
<div id="menu-bar-hover-placeholder"></div>
8795
<div id="menu-bar" class="menu-bar sticky bordered">
8896
<div class="left-buttons">
8997
<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 @@
93101
<i class="fa fa-paint-brush"></i>
94102
</button>
95103
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
96-
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
104+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
97105
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
98106
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
99107
<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>
110118
<a href="print.html" title="Print this book" aria-label="Print this book">
111119
<i id="print-button" class="fa fa-print"></i>
112120
</a>
121+
113122
</div>
114123
</div>
115124

@@ -123,8 +132,9 @@ <h1 class="menu-title">Zellij User Guide</h1>
123132
</ul>
124133
</div>
125134
</div>
135+
126136
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
127-
<script type="text/javascript">
137+
<script>
128138
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
129139
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
130140
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
@@ -135,6 +145,11 @@ <h1 class="menu-title">Zellij User Guide</h1>
135145
<div id="content" class="content">
136146
<main>
137147
<h1 id="example-plugins"><a class="header" href="#example-plugins">Example Plugins</a></h1>
148+
<h3 id="harpoon"><a class="header" href="#harpoon"><a href="https://github.com/Nacho114/harpoon">harpoon</a></a></h3>
149+
<p><img src="/video/harpoon-preview.gif" alt="harpoon preview" /></p>
150+
<p><a href="https://github.com/Nacho114/harpoon">harpoon</a> enables quick navigation to your favorite panes.
151+
You can use <code>a</code> to add the current pane to your harpoon list. You can navigate harpoon using <code>Up</code>,
152+
<code>Down</code>, or using vim navigation. To go to the pane you just press <code>Enter</code>.</p>
138153
<h3 id="jbz"><a class="header" href="#jbz"><a href="https://github.com/nim65s/jbz">jbz</a></a></h3>
139154
<p><img src="/video/jbz-preview.gif" alt="jbz preview" /></p>
140155
<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
166181
<a rel="prev" href="plugin-upgrading.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
167182
<i class="fa fa-angle-left"></i>
168183
</a>
184+
169185
<a rel="next" href="plugin-other-languages.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
170186
<i class="fa fa-angle-right"></i>
171187
</a>
188+
172189
<div style="clear: both"></div>
173190
</nav>
174191
</div>
@@ -178,23 +195,33 @@ <h3 id="room"><a class="header" href="#room"><a href="https://github.com/rvcas/r
178195
<a rel="prev" href="plugin-upgrading.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
179196
<i class="fa fa-angle-left"></i>
180197
</a>
198+
181199
<a rel="next" href="plugin-other-languages.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
182200
<i class="fa fa-angle-right"></i>
183201
</a>
184202
</nav>
185203

186204
</div>
187205

188-
<script type="text/javascript">
206+
207+
208+
209+
<script>
189210
window.playground_copyable = true;
190211
</script>
191-
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
192-
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
193-
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
194-
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
195-
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
196-
<script src="book.js" type="text/javascript" charset="utf-8"></script>
212+
213+
214+
<script src="elasticlunr.min.js"></script>
215+
<script src="mark.min.js"></script>
216+
<script src="searcher.js"></script>
217+
218+
<script src="clipboard.min.js"></script>
219+
<script src="highlight.js"></script>
220+
<script src="book.js"></script>
197221

198222
<!-- Custom JS scripts -->
223+
224+
225+
</div>
199226
</body>
200227
</html>

‎static/documentation/print.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2702,6 +2702,11 @@ <h2 id="registering-a-plugin"><a class="header" href="#registering-a-plugin">Reg
27022702
<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>
27032703
<p>The Zellij maintainers are aware this is an inconvenient and undesired scenario and are working on a more robust solution.</p>
27042704
<div style="break-before: page; page-break-before: always;"></div><h1 id="example-plugins"><a class="header" href="#example-plugins">Example Plugins</a></h1>
2705+
<h3 id="harpoon"><a class="header" href="#harpoon"><a href="https://github.com/Nacho114/harpoon">harpoon</a></a></h3>
2706+
<p><img src="/video/harpoon-preview.gif" alt="harpoon preview" /></p>
2707+
<p><a href="https://github.com/Nacho114/harpoon">harpoon</a> enables quick navigation to your favorite panes.
2708+
You can use <code>a</code> to add the current pane to your harpoon list. You can navigate harpoon using <code>Up</code>,
2709+
<code>Down</code>, or using vim navigation. To go to the pane you just press <code>Enter</code>.</p>
27052710
<h3 id="jbz"><a class="header" href="#jbz"><a href="https://github.com/nim65s/jbz">jbz</a></a></h3>
27062711
<p><img src="/video/jbz-preview.gif" alt="jbz preview" /></p>
27072712
<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
27202725
<p><img src="/img/multitask-preview.png" alt="multitask plugin preview" /></p>
27212726
<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>
27222727
<p>Did one command fail? No problem! Fix the issue, re-run it with ENTER and the pipeline will continue.</p>
2728+
<h3 id="room"><a class="header" href="#room"><a href="https://github.com/rvcas/room">room</a></a></h3>
2729+
<p><img src="/video/room-preview.gif" alt="room preview" /></p>
2730+
<p><a href="https://github.com/rvcas/room">room</a> is for quickly searching and switching between tabs.
2731+
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
2732+
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>
27232733
<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>
27242734
<p>Here's a list of other SDKs for developing Zellij plugins in languages other than Rust:</p>
27252735
<ol>

‎static/documentation/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎static/documentation/searchindex.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎static/video/harpoon-preview.gif

1.87 MB
Loading

0 commit comments

Comments
 (0)