1<!doctype html>
2<html lang="en">
3<head>
4<meta charset="utf-8">
5<meta name="viewport" content="width=device-width, initial-scale=1">
6<meta name="color-scheme" content="light dark">
7<title>docs · files · example.test</title>
8<meta name="theme-color" media="(prefers-color-scheme: light)" content="#ffffff">
9<meta name="theme-color" media="(prefers-color-scheme: dark)" content="#0c0c0c">
10<meta name="apple-mobile-web-app-title" content="ermite">
11<link rel="icon" type="image/svg+xml" href="/-/static/img/icon.HASH.svg">
12<link rel="apple-touch-icon" href="/-/static/app/apple-touch-icon.HASH.png">
13<link rel="manifest" href="/-/static/app/manifest.HASH.webmanifest">
14<link rel="preload" href="/-/static/fonts/atkinson-next.HASH.woff2" as="font" type="font/woff2" crossorigin>
15<link rel="stylesheet" href="/-/static/css/ermite.HASH.css">
16<meta name="htmx-config" content='{"history":false,"includeIndicatorCSS":false,"extensions":"sse, hx-live"}'>
17<script src="/-/static/js/htmx.min.HASH.js" defer>
18</script>
19<script src="/-/static/js/hx-live.min.HASH.js" defer>
20</script>
21<script src="/-/static/js/hx-sse.min.HASH.js" defer>
22</script>
23<script src="/-/static/js/ermite.HASH.js" defer>
24</script>
25<script src="/-/static/js/files.HASH.js" defer>
26</script>
27<script src="/-/static/js/passkey.HASH.js" defer>
28</script>
29<script src="/-/static/js/log.HASH.js" defer>
30</script>
31</head>
32<body data-ref="main" data-sha="SHA40" data-sel="" data-nav="" data-paths="/files/paths/SHA40" data-blob="/files/blob/main">
33<a class="skip" href="#main">skip to content</a>
34<header class="hdr">
35<div class="hdr-top">
36<a class="brand" href="/" data-g="h" aria-label="home" title="home (g h)">
37<span class="brand-mark" aria-hidden="true">
38</span>
39</a>
40<nav class="crumbs" aria-label="Path">
41<ol>
42<li>
43<a href="/files">files</a>
44</li>
45<li>
46<a href="/files/tree/main">tree</a>
47</li>
48<li>
49<a href="/files/tree/main">main</a>
50</li>
51<li>
52<a href="/files/tree/main/docs" aria-current="page">docs</a>
53</li>
54</ol>
55</nav>
56<div class="hdr-acts">
57<a class="btn ref" href="/files/refs" data-fire="refs" aria-keyshortcuts="b" title="switch branch or tag (b)">
58<span class="ico i-branch" aria-hidden="true">
59</span>
60<span class="ref-name">main</span>
61<span class="sha">SHA7</span>
62</a>
63<button type="button" class="btn search" data-js aria-haspopup="dialog" aria-controls="panel-cmd" aria-keyshortcuts="Control+K :" title="go to a section, ref, file or repo (ctrl k or :)" data-fire="cmd">
64<span class="ico i-search" aria-hidden="true">
65</span>
66<span class="search-label">Go to…</span>
67<kbd aria-hidden="true">ctrl k</kbd>
68</button>
69<button type="button" class="btn icon" data-install hidden aria-label="Install app" title="install ermite as an app">
70<span class="ico i-download" aria-hidden="true">
71</span>
72</button>
73</div>
74</div>
75<nav class="tabs" aria-label="Sections">
76<ul>
77<li>
78<a href="/files" data-key="s" aria-keyshortcuts="s">Summary <kbd aria-hidden="true">s</kbd>
79</a>
80</li>
81<li>
82<a href="/files/tree/main" data-key="t" aria-keyshortcuts="t" aria-current="page">Files <kbd aria-hidden="true">t</kbd>
83</a>
84</li>
85<li>
86<a href="/files/commits/main" data-key="c" aria-keyshortcuts="c">Commits <kbd aria-hidden="true">c</kbd>
87</a>
88</li>
89<li>
90<a href="/files/refs" data-key="r" aria-keyshortcuts="r">Branches & tags <kbd aria-hidden="true">r</kbd>
91</a>
92</li>
93<li>
94<a href="/files/merge-requests" data-key="m" aria-keyshortcuts="m">Merge requests <kbd aria-hidden="true">m</kbd>
95</a>
96</li>
97<li>
98<a href="/files/actions" data-key="a" aria-keyshortcuts="a">Actions <kbd aria-hidden="true">a</kbd>
99</a>
100</li>
101</ul>
102</nav>
103</header>
104<div class="work">
105<main id="main" tabindex="-1">
106<div class="tree-find">
107<div class="filter wide">
108<label for="finder-q" class="sr">find a file</label>
109<input id="finder-q" type="search" data-filter role="combobox" aria-autocomplete="list" aria-controls="finder-list" aria-expanded="false" placeholder="Find a file in this repository…" autocomplete="off" spellcheck="false" hx-on:focus="ermiteFinder.load()" hx-on:input="ermiteFinder.input(this)" hx-on:keydown="ermiteFinder.key(this, event)">
110</div>
111<p class="tree-keys" data-js aria-hidden="true">
112<kbd>j</kbd>
113<kbd>k</kbd> move · <kbd>l</kbd> open · <kbd>h</kbd> back</p>
114</div>
115<div id="finder" class="tree-card" hidden>
116<p id="finder-status" class="dim" aria-live="polite">
117</p>
118<ul id="finder-list" class="cmd-list" role="listbox" aria-label="Files">
119</ul>
120</div>
121<div id="tree-view" class="tree-card">
122<div class="tree-head">
123<span class="tree-path">docs/</span>
124<a class="tree-up" href="/files/tree/main" title="parent directory (h)">..</a>
125<span class="tree-count">2 entries</span>
126</div>
127<ul id="tree-rows" class="tree" role="tree" aria-label="Entries" data-rows data-tree data-up="/files/tree/main" hx-on:click="ermiteTree.click(event)">
128<li role="treeitem" aria-level="1" aria-posinset="1" aria-setsize="2" data-kind="file" data-depth="0" data-cursor>
129<span class="t-main">
130<span class="t-twig" aria-hidden="true">
131</span>
132<span class="t-node" aria-hidden="true">
133</span>
134<a class="t-name" href="/files/blob/main/docs/README.md">README.md</a>
135</span>
136<span class="t-size">62 B</span>
137<span class="t-sub">
138<a class="t-commit" href="/files/commit/SHA40" title="T">add docs/README.md</a>
139</span>
140<span class="t-when">
141<time datetime="STAMP" title="STAMP">AGO</time>
142</span>
143</li>
144<li role="treeitem" aria-level="1" aria-posinset="2" aria-setsize="2" data-kind="file" data-depth="0">
145<span class="t-main">
146<span class="t-twig" aria-hidden="true">
147</span>
148<span class="t-node" aria-hidden="true">
149</span>
150<a class="t-name" href="/files/blob/main/docs/guide.md">guide.md</a>
151</span>
152<span class="t-size">47 B</span>
153<span class="t-sub">
154<a class="t-commit" href="/files/commit/SHA40" title="T">add docs/guide.md</a>
155</span>
156<span class="t-when">
157<time datetime="STAMP" title="STAMP">AGO</time>
158</span>
159</li>
160</ul>
161</div>
162</main>
163</div>
164<footer class="foot">
165<span>ermite devel</span>
166<a href="http://example.test/ermite" rel="noopener" title="source of this version (AGPL-3.0-or-later)">source</a>
167<button type="button" class="foot-keys" data-js data-fire="help" aria-haspopup="dialog" aria-controls="panel-help" aria-keyshortcuts="?">
168<kbd aria-hidden="true">?</kbd> keyboard shortcuts</button>
169</footer>
170<div class="hint" role="status" aria-live="polite">
171<span class="hint-nav" :text="document.body.dataset.nav || ''">
172</span>
173<span class="hint-sel" :text="document.body.dataset.sel ? document.body.dataset.sel + ' · y permalink' : ''">
174</span>
175<span class="hint-flash" :text="document.body.dataset.flash || ''">
176</span>
177</div>
178<dialog id="panel-help" class="panel modal" aria-label="Keyboard shortcuts" hx-on:keydown="event.key === 'Escape' && (event.preventDefault(), this.close())" hx-on:click="event.target === this && this.close()">
179<div class="panel-head">
180<h2>Keyboard shortcuts</h2>
181<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
182<kbd>esc</kbd> close</button>
183</div>
184<div class="keys-pref">
185<label>
186<input type="checkbox" id="keys-off" aria-describedby="keys-note" hx-on:change="ermite.setKeysOff(this.checked)"> Turn off single-key shortcuts</label>
187<p id="keys-note" class="dim">Single-key shortcuts are on. ctrl k and esc work whatever this says.</p>
188</div>
189<dl class="keys">
190<div>
191<dt>
192<kbd>ctrl k</kbd>
193<kbd>:</kbd>
194</dt>
195<dd>go to a section, branch, tag, file or repository</dd>
196</div>
197<div>
198<dt>
199<kbd>?</kbd>
200</dt>
201<dd>this list</dd>
202</div>
203<div>
204<dt>
205<kbd>j</kbd>
206<kbd>k</kbd>
207</dt>
208<dd>move the row cursor down / up</dd>
209</div>
210<div>
211<dt>
212<kbd>enter</kbd>
213</dt>
214<dd>open the row under the cursor; on Files, a directory opens or closes in place</dd>
215</div>
216<div>
217<dt>
218<kbd>↑</kbd>
219<kbd>↓</kbd>
220<kbd>←</kbd>
221<kbd>→</kbd>
222<kbd>home</kbd>
223<kbd>end</kbd>
224</dt>
225<dd>in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file</dd>
226</div>
227<div>
228<dt>
229<kbd>l</kbd>
230<kbd>h</kbd>
231</dt>
232<dd>on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls</dd>
233</div>
234<div>
235<dt>
236<kbd>g g</kbd>
237<kbd>G</kbd>
238</dt>
239<dd>first / last row</dd>
240</div>
241<div>
242<dt>
243<kbd>/</kbd>
244</dt>
245<dd>filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)</dd>
246</div>
247<div>
248<dt>
249<kbd>b</kbd>
250</dt>
251<dd>switch branch or tag</dd>
252</div>
253<div>
254<dt>
255<kbd>s</kbd>
256<kbd>t</kbd>
257<kbd>c</kbd>
258<kbd>r</kbd>
259<kbd>m</kbd>
260</dt>
261<dd>tabs: summary, files, commits, branches & tags, merge requests</dd>
262</div>
263<div>
264<dt>
265<kbd>g h</kbd>
266</dt>
267<dd>home</dd>
268</div>
269<div>
270<dt>
271<kbd>y</kbd>
272</dt>
273<dd>copy a permalink pinned to the commit</dd>
274</div>
275<div>
276<dt>
277<kbd>d</kbd>
278<kbd>u</kbd>
279<kbd>x</kbd>
280</dt>
281<dd>diff: split / unified / collapse or expand all</dd>
282</div>
283<div>
284<dt>
285<kbd>e</kbd>
286<kbd>E</kbd>
287</dt>
288<dd>diff: the whole file in view / every file, with the lines the hunks hide</dd>
289</div>
290<div>
291<dt>
292<kbd>n</kbd>
293</dt>
294<dd>merge request: next note in the diff</dd>
295</div>
296<div>
297<dt>
298<kbd>esc</kbd>
299</dt>
300<dd>close a dialog, leave a field</dd>
301</div>
302</dl>
303</dialog>
304<dialog id="panel-refs" class="panel modal" aria-label="Switch ref" hx-on:keydown="event.key === 'Escape' && (event.preventDefault(), this.close())" hx-on:click="event.target === this && this.close()">
305<div class="panel-head">
306<label for="refs-filter" class="sr">filter branches and tags</label>
307<input id="refs-filter" type="search" placeholder="Switch branch or tag…" autocomplete="off" data-pick="#panel-refs li" hx-on:input="ermite.filter(this)">
308<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
309<kbd>esc</kbd>
310</button>
311</div>
312<div class="panel-cols" data-picklist>
313<section aria-label="Branches">
314<h2>Branches <span class="count">2</span>
315</h2>
316<ul>
317<li>
318<a href="/files/tree/feature/x">
319<span class="mark" aria-hidden="true"> </span>feature/x</a>
320</li>
321<li>
322<a href="/files/tree/main" aria-current="true">
323<span class="mark" aria-hidden="true">●</span>main</a>
324</li>
325</ul>
326</section>
327<section aria-label="Tags">
328<h2>Tags <span class="count">1</span>
329</h2>
330<ul>
331<li>
332<a href="/files/tree/v1.0">
333<span class="mark" aria-hidden="true"> </span>v1.0</a>
334</li>
335</ul>
336</section>
337</div>
338</dialog>
339<dialog id="panel-cmd" class="panel modal" aria-label="Go to" hx-on:close="ermiteFinder.paletteClose()" hx-on:keydown="event.key === 'Escape' && (event.preventDefault(), this.close())" hx-on:click="event.target === this && this.close()">
340<div class="panel-head">
341<label for="cmd-q" class="sr">go to</label>
342<input id="cmd-q" type="search" placeholder="Go to a section, branch, tag, file or repository…" autocomplete="off" spellcheck="false" role="combobox" aria-autocomplete="list" aria-expanded="true" aria-controls="cmd-list" aria-activedescendant="cmd-o0" hx-on:input="ermite.cmdFilter(this); ermiteFinder.palette(this)" hx-on:keydown="ermite.cmdKey(event)">
343<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
344<kbd>esc</kbd>
345</button>
346</div>
347<ul id="cmd-list" class="cmd-list" role="listbox" aria-label="Targets">
348<li id="cmd-o0" role="option" aria-selected="true" data-k="go home" data-cursor>
349<a href="/" tabindex="-1">
350<span class="lbl">home</span>
351<span class="k">go</span>
352</a>
353</li>
354<li id="cmd-o1" role="option" aria-selected="false" data-k="section summary">
355<a href="/files" tabindex="-1">
356<span class="lbl">summary</span>
357<span class="k">section</span>
358</a>
359</li>
360<li id="cmd-o2" role="option" aria-selected="false" data-k="section files">
361<a href="/files/tree/main" tabindex="-1">
362<span class="lbl">files</span>
363<span class="k">section</span>
364</a>
365</li>
366<li id="cmd-o3" role="option" aria-selected="false" data-k="section commits">
367<a href="/files/commits/main" tabindex="-1">
368<span class="lbl">commits</span>
369<span class="k">section</span>
370</a>
371</li>
372<li id="cmd-o4" role="option" aria-selected="false" data-k="section branches & tags">
373<a href="/files/refs" tabindex="-1">
374<span class="lbl">branches & tags</span>
375<span class="k">section</span>
376</a>
377</li>
378<li id="cmd-o5" role="option" aria-selected="false" data-k="section merge requests">
379<a href="/files/merge-requests" tabindex="-1">
380<span class="lbl">merge requests</span>
381<span class="k">section</span>
382</a>
383</li>
384<li id="cmd-o6" role="option" aria-selected="false" data-k="section actions">
385<a href="/files/actions" tabindex="-1">
386<span class="lbl">actions</span>
387<span class="k">section</span>
388</a>
389</li>
390<li id="cmd-o7" role="option" aria-selected="false" data-k="branch feature/x">
391<a href="/files/tree/feature/x" tabindex="-1">
392<span class="lbl">feature/x</span>
393<span class="k">branch</span>
394</a>
395</li>
396<li id="cmd-o8" role="option" aria-selected="false" data-k="branch main">
397<a href="/files/tree/main" tabindex="-1">
398<span class="lbl">main</span>
399<span class="k">branch</span>
400</a>
401</li>
402<li id="cmd-o9" role="option" aria-selected="false" data-k="tag v1.0">
403<a href="/files/tree/v1.0" tabindex="-1">
404<span class="lbl">v1.0</span>
405<span class="k">tag</span>
406</a>
407</li>
408<li id="cmd-o10" role="option" aria-selected="false" data-k="action turn single-key shortcuts on off keyboard">
409<a href="#" data-fire="keys" tabindex="-1">
410<span class="lbl">turn single-key shortcuts off</span>
411<span class="k">action</span>
412</a>
413</li>
414</ul>
415<p class="panel-foot">
416<span>
417<kbd>↑</kbd>
418<kbd>↓</kbd> move</span>
419<span>
420<kbd>enter</kbd> open</span>
421<span>
422<kbd>esc</kbd> close</span>
423</p>
424</dialog>
425<div id="keys" hidden hx-on="k-j from:body -> ermite.move(1);
426 k-k from:body -> ermite.move(-1);
427 k-top from:body -> ermite.edge(false);
428 k-bottom from:body -> ermite.edge(true);
429 k-open from:body -> ermite.open();
430 k-right from:body -> ermite.rail(true);
431 k-left from:body -> ermite.rail(false);
432 k-esc from:body -> ermite.closeDialogs();
433 k-help from:body -> ermite.dialog('panel-help');
434 k-refs from:body -> ermite.dialog('panel-refs', 'refs-filter');
435 k-cmd from:body -> ermite.dialog('panel-cmd', 'cmd-q'); ermiteFinder.load();
436 k-filter from:body -> ermite.focusFilter();
437 k-gh from:body -> ermite.go('.brand');
438 k-s from:body -> ermite.tab('s');
439 k-t from:body -> ermite.tab('t');
440 k-c from:body -> ermite.tab('c');
441 k-r from:body -> ermite.tab('r');
442 k-m from:body -> ermite.tab('m');
443 k-next from:body -> ermite.nextNote();
444 k-split from:body -> ermite.layout('split');
445 k-unified from:body -> ermite.layout('unified');
446 k-collapse from:body -> ermite.collapse();
447 k-expand from:body -> ermite.expandFile();
448 k-expandAll from:body -> ermite.expandAll();
449 k-permalink from:body -> ermite.permalink();
450 k-merge from:body -> window.ermiteMR?.openMerge();
451 k-read from:body -> window.ermiteMR?.markRead();
452 k-gf from:body -> window.ermiteMR?.focusFiles();
453 k-keys from:body -> ermite.toggleKeys()">
454</div>
455</body>
456</html>