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