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