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