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/guide.md · 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">
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">blob</a>
49</li>
50<li>
51<a href="/files/tree/main">main</a>
52</li>
53<li>
54<a href="/files/tree/main/docs">docs</a>
55</li>
56<li>
57<a href="/files/blob/main/docs/guide.md" aria-current="page">guide.md</a>
58</li>
59</ol>
60</nav>
61<div class="hdr-acts">
62<a class="btn ref" href="/files/refs" data-fire="refs" aria-keyshortcuts="b" title="switch branch or tag (b)">
63<span class="ico i-branch" aria-hidden="true">
64</span>
65<span class="ref-name">main</span>
66<span class="sha">SHA7</span>
67</a>
68<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">
69<span class="ico i-search" aria-hidden="true">
70</span>
71<span class="search-label">Go to…</span>
72<kbd aria-hidden="true">ctrl k</kbd>
73</button>
74</div>
75</div>
76<nav class="tabs" aria-label="Sections">
77<ul>
78<li>
79<a href="/files" data-key="s" aria-keyshortcuts="s">Summary <kbd aria-hidden="true">s</kbd>
80</a>
81</li>
82<li>
83<a href="/files/tree/main" data-key="t" aria-keyshortcuts="t" aria-current="page">Files <kbd aria-hidden="true">t</kbd>
84</a>
85</li>
86<li>
87<a href="/files/commits/main" data-key="c" aria-keyshortcuts="c">Commits <kbd aria-hidden="true">c</kbd>
88</a>
89</li>
90<li>
91<a href="/files/refs" data-key="r" aria-keyshortcuts="r">Branches & tags <kbd aria-hidden="true">r</kbd>
92</a>
93</li>
94<li>
95<a href="/files/merge-requests" data-key="m" aria-keyshortcuts="m">Merge requests <kbd aria-hidden="true">m</kbd>
96</a>
97</li>
98<li>
99<a href="/files/releases" data-key="l" aria-keyshortcuts="l">Releases <kbd aria-hidden="true">l</kbd>
100</a>
101</li>
102<li>
103<a href="/files/actions" data-key="a" aria-keyshortcuts="a">Actions <kbd aria-hidden="true">a</kbd>
104</a>
105</li>
106</ul>
107</nav>
108</header>
109<div class="work has-rail">
110<main id="main" tabindex="-1">
111<h1 class="file-h">
112<span>guide.md</span>
113<span class="acts">
114<a class="btn" href="/files/raw/main/docs/guide.md">Raw</a>
115<a class="btn" href="/files/commits/main/docs/guide.md">History</a>
116<a class="btn" href="/files/tree/main/docs">Folder</a>
117</span>
118</h1>
119<article class="prose" aria-label="guide.md" hx-ignore>
120<h1 id="md-guide">Guide</h1>
121<h2 id="md-steps">Steps</h2>
122<p>Run it.</p>
123<pre class="chroma">
124<code class="language-sh">make all
125</code>
126</pre>
127</article>
128<details class="source">
129<summary>source</summary>
130<pre class="chroma code" data-anchor="" hx-on:click="let a = event.target.closest('a.ln'); if (!a) return; event.preventDefault();
131 let n = +a.textContent; if (!event.shiftKey || !data.anchor) data.anchor = n;
132 let lo = Math.min(+data.anchor, n), hi = Math.max(+data.anchor, n);
133 history.replaceState(null, '', '#L' + lo + (hi > lo ? '-L' + hi : '')); trigger('sel')" hx-on:sel="let m = location.hash.match(/^#L(\d+)(?:-L(\d+))?$/); let lo = m ? +m[1] : 0, hi = m ? +(m[2] || m[1]) : 0;
134 q('.line in this').arr().forEach(l => { let k = +l.id.slice(1); l.classList.toggle('sel', k >= lo && k <= hi) });
135 document.body.dataset.sel = lo ? 'L' + lo + (hi > lo ? '-L' + hi + ' · ' + (hi - lo + 1) + ' lines' : '') : '';
136 if (lo && event.detail?.scroll) document.getElementById('L' + lo)?.scrollIntoView({ block: 'center' })" hx-live="if (!data.ready) { data.ready = '1'; trigger('sel', { scroll: true }) }" data-ready="">
137<code hx-ignore>
138<span class="line" id="L1">
139<a class="ln" href="#L1">1</a>
140<span class="gh"># Guide</span>
141</span>
142<span class="line" id="L2">
143<a class="ln" href="#L2">2</a>
144</span>
145<span class="line" id="L3">
146<a class="ln" href="#L3">3</a>
147<span class="gu">## Steps</span>
148</span>
149<span class="line" id="L4">
150<a class="ln" href="#L4">4</a>
151</span>
152<span class="line" id="L5">
153<a class="ln" href="#L5">5</a>Run it.</span>
154<span class="line" id="L6">
155<a class="ln" href="#L6">6</a>
156</span>
157<span class="line" id="L7">
158<a class="ln" href="#L7">7</a>
159<span class="s">```sh</span>
160</span>
161<span class="line" id="L8">
162<a class="ln" href="#L8">8</a>make all</span>
163<span class="line" id="L9">
164<a class="ln" href="#L9">9</a>
165<span class="s">```</span>
166</span>
167</code>
168</pre>
169</details>
170</main>
171<aside class="rail" aria-label="Context">
172<section aria-labelledby="r-file">
173<h2 id="r-file">File</h2>
174<dl class="kv">
175<dt>size</dt>
176<dd>47 B</dd>
177<dt>lines</dt>
178<dd>9</dd>
179<dt>type</dt>
180<dd>markdown</dd>
181</dl>
182</section>
183<section aria-labelledby="r-last">
184<h2 id="r-last">Last change <a href="/files/commits/main/docs/guide.md">History</a>
185</h2>
186<p>
187<a href="/files/commit/SHA40">SHA7</a> add docs/guide.md</p>
188<p class="dim">T · <time datetime="STAMP" title="STAMP">AGO</time>
189</p>
190</section>
191<section aria-labelledby="r-outline">
192<h2 id="r-outline">On this page</h2>
193<nav class="outline" aria-label="Outline">
194<a class="l1" href="#md-guide">Guide</a>
195<a class="l2" href="#md-steps">Steps</a>
196</nav>
197</section>
198<section aria-labelledby="r-sel">
199<h2 id="r-sel">Selection</h2>
200<p :text="document.body.dataset.sel || 'none · click a line number, shift-click extends'">none · click a line number, shift-click extends</p>
201<p class="dim">y copies a permalink pinned to the commit sha</p>
202</section>
203</aside>
204</div>
205<footer class="foot">
206<span>ermite devel</span>
207<a href="http://example.test/ermite" rel="noopener" title="source of this version (AGPL-3.0-or-later)">source</a>
208<button type="button" class="foot-keys" data-js data-fire="help" aria-haspopup="dialog" aria-controls="panel-help" aria-keyshortcuts="?">
209<kbd aria-hidden="true">?</kbd> keyboard shortcuts</button>
210</footer>
211<div class="hint" role="status" aria-live="polite">
212<span class="hint-nav" :text="document.body.dataset.nav || ''">
213</span>
214<span class="hint-sel" :text="document.body.dataset.sel ? document.body.dataset.sel + ' · y permalink' : ''">
215</span>
216<span class="hint-flash" :text="document.body.dataset.flash || ''">
217</span>
218</div>
219<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()">
220<div class="panel-head">
221<h2>Keyboard shortcuts</h2>
222<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
223<kbd>esc</kbd> close</button>
224</div>
225<div class="keys-pref">
226<label>
227<input type="checkbox" id="keys-off" aria-describedby="keys-note" hx-on:change="ermite.setKeysOff(this.checked)"> Turn off single-key shortcuts</label>
228<p id="keys-note" class="dim">Single-key shortcuts are on. ctrl k and esc work whatever this says.</p>
229</div>
230<dl class="keys">
231<div>
232<dt>
233<kbd>ctrl k</kbd>
234<kbd>:</kbd>
235</dt>
236<dd>go to a section, branch, tag, file or repository</dd>
237</div>
238<div>
239<dt>
240<kbd>?</kbd>
241</dt>
242<dd>this list</dd>
243</div>
244<div>
245<dt>
246<kbd>j</kbd>
247<kbd>k</kbd>
248</dt>
249<dd>move the row cursor down / up</dd>
250</div>
251<div>
252<dt>
253<kbd>enter</kbd>
254</dt>
255<dd>open the row under the cursor; on Files, a directory opens or closes in place</dd>
256</div>
257<div>
258<dt>
259<kbd>↑</kbd>
260<kbd>↓</kbd>
261<kbd>←</kbd>
262<kbd>→</kbd>
263<kbd>home</kbd>
264<kbd>end</kbd>
265</dt>
266<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>
267</div>
268<div>
269<dt>
270<kbd>l</kbd>
271<kbd>h</kbd>
272</dt>
273<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>
274</div>
275<div>
276<dt>
277<kbd>g g</kbd>
278<kbd>G</kbd>
279</dt>
280<dd>first / last row</dd>
281</div>
282<div>
283<dt>
284<kbd>/</kbd>
285</dt>
286<dd>filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)</dd>
287</div>
288<div>
289<dt>
290<kbd>b</kbd>
291</dt>
292<dd>switch branch or tag</dd>
293</div>
294<div>
295<dt>
296<kbd>s</kbd>
297<kbd>t</kbd>
298<kbd>c</kbd>
299<kbd>r</kbd>
300<kbd>m</kbd>
301<kbd>i</kbd>
302</dt>
303<dd>tabs: summary, files, commits, branches & tags, merge requests, issues</dd>
304</div>
305<div>
306<dt>
307<kbd>g h</kbd>
308</dt>
309<dd>home</dd>
310</div>
311<div>
312<dt>
313<kbd>w</kbd>
314</dt>
315<dd>wide mode: use the whole width of the screen, or not (remembered)</dd>
316</div>
317<div>
318<dt>
319<kbd>y</kbd>
320</dt>
321<dd>copy a permalink pinned to the commit</dd>
322</div>
323<div>
324<dt>
325<kbd>d</kbd>
326<kbd>u</kbd>
327<kbd>x</kbd>
328</dt>
329<dd>diff: split / unified / collapse or expand all</dd>
330</div>
331<div>
332<dt>
333<kbd>e</kbd>
334<kbd>E</kbd>
335</dt>
336<dd>diff: the whole file in view / every file, with the lines the hunks hide</dd>
337</div>
338<div>
339<dt>
340<kbd>n</kbd>
341</dt>
342<dd>merge request: next note in the diff</dd>
343</div>
344<div>
345<dt>
346<kbd>esc</kbd>
347</dt>
348<dd>close a dialog, leave a field</dd>
349</div>
350</dl>
351</dialog>
352<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()">
353<div class="panel-head">
354<label for="refs-filter" class="sr">filter branches and tags</label>
355<input id="refs-filter" type="search" placeholder="Switch branch or tag…" autocomplete="off" data-pick="#panel-refs li" hx-on:input="ermite.filter(this)">
356<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
357<kbd>esc</kbd>
358</button>
359</div>
360<div class="panel-cols" data-picklist>
361<section aria-label="Branches">
362<h2>Branches <span class="count">2</span>
363</h2>
364<ul>
365<li>
366<a href="/files/tree/feature/x">
367<span class="mark" aria-hidden="true"> </span>feature/x</a>
368</li>
369<li>
370<a href="/files/tree/main" aria-current="true">
371<span class="mark" aria-hidden="true">●</span>main</a>
372</li>
373</ul>
374</section>
375<section aria-label="Tags">
376<h2>Tags <span class="count">1</span>
377</h2>
378<ul>
379<li>
380<a href="/files/tree/v1.0">
381<span class="mark" aria-hidden="true"> </span>v1.0</a>
382</li>
383</ul>
384</section>
385</div>
386</dialog>
387<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()">
388<div class="panel-head">
389<label for="cmd-q" class="sr">go to</label>
390<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)">
391<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
392<kbd>esc</kbd>
393</button>
394</div>
395<ul id="cmd-list" class="cmd-list" role="listbox" aria-label="Targets">
396<li id="cmd-o0" role="option" aria-selected="true" data-k="go home" data-cursor>
397<a href="/" tabindex="-1">
398<span class="lbl">home</span>
399<span class="k">go</span>
400</a>
401</li>
402<li id="cmd-o1" role="option" aria-selected="false" data-k="section summary">
403<a href="/files" tabindex="-1">
404<span class="lbl">summary</span>
405<span class="k">section</span>
406</a>
407</li>
408<li id="cmd-o2" role="option" aria-selected="false" data-k="section files">
409<a href="/files/tree/main" tabindex="-1">
410<span class="lbl">files</span>
411<span class="k">section</span>
412</a>
413</li>
414<li id="cmd-o3" role="option" aria-selected="false" data-k="section commits">
415<a href="/files/commits/main" tabindex="-1">
416<span class="lbl">commits</span>
417<span class="k">section</span>
418</a>
419</li>
420<li id="cmd-o4" role="option" aria-selected="false" data-k="section branches & tags">
421<a href="/files/refs" tabindex="-1">
422<span class="lbl">branches & tags</span>
423<span class="k">section</span>
424</a>
425</li>
426<li id="cmd-o5" role="option" aria-selected="false" data-k="section merge requests">
427<a href="/files/merge-requests" tabindex="-1">
428<span class="lbl">merge requests</span>
429<span class="k">section</span>
430</a>
431</li>
432<li id="cmd-o6" role="option" aria-selected="false" data-k="section releases">
433<a href="/files/releases" tabindex="-1">
434<span class="lbl">releases</span>
435<span class="k">section</span>
436</a>
437</li>
438<li id="cmd-o7" role="option" aria-selected="false" data-k="section actions">
439<a href="/files/actions" tabindex="-1">
440<span class="lbl">actions</span>
441<span class="k">section</span>
442</a>
443</li>
444<li id="cmd-o8" role="option" aria-selected="false" data-k="branch feature/x">
445<a href="/files/tree/feature/x" tabindex="-1">
446<span class="lbl">feature/x</span>
447<span class="k">branch</span>
448</a>
449</li>
450<li id="cmd-o9" role="option" aria-selected="false" data-k="branch main">
451<a href="/files/tree/main" tabindex="-1">
452<span class="lbl">main</span>
453<span class="k">branch</span>
454</a>
455</li>
456<li id="cmd-o10" role="option" aria-selected="false" data-k="tag v1.0">
457<a href="/files/tree/v1.0" tabindex="-1">
458<span class="lbl">v1.0</span>
459<span class="k">tag</span>
460</a>
461</li>
462<li id="cmd-o11" role="option" aria-selected="false" data-k="action turn single-key shortcuts on off keyboard">
463<a href="#" data-fire="keys" tabindex="-1">
464<span class="lbl">turn single-key shortcuts off</span>
465<span class="k">action</span>
466</a>
467</li>
468</ul>
469<p class="panel-foot">
470<span>
471<kbd>↑</kbd>
472<kbd>↓</kbd> move</span>
473<span>
474<kbd>enter</kbd> open</span>
475<span>
476<kbd>esc</kbd> close</span>
477</p>
478</dialog>
479<div id="keys" hidden hx-on="k-j from:body -> ermite.move(1);
480 k-k from:body -> ermite.move(-1);
481 k-top from:body -> ermite.edge(false);
482 k-bottom from:body -> ermite.edge(true);
483 k-open from:body -> ermite.open();
484 k-right from:body -> ermite.rail(true);
485 k-left from:body -> ermite.rail(false);
486 k-esc from:body -> ermite.closeDialogs();
487 k-help from:body -> ermite.dialog('panel-help');
488 k-refs from:body -> ermite.dialog('panel-refs', 'refs-filter');
489 k-cmd from:body -> ermite.dialog('panel-cmd', 'cmd-q'); ermiteFinder.load();
490 k-filter from:body -> ermite.focusFilter();
491 k-gh from:body -> ermite.go('.brand');
492 k-s from:body -> ermite.tab('s');
493 k-t from:body -> ermite.tab('t');
494 k-c from:body -> ermite.tab('c');
495 k-r from:body -> ermite.tab('r');
496 k-m from:body -> ermite.tab('m');
497 k-i from:body -> ermite.tab('i');
498 k-next from:body -> ermite.nextNote();
499 k-split from:body -> ermite.layout('split');
500 k-unified from:body -> ermite.layout('unified');
501 k-collapse from:body -> ermite.collapse();
502 k-wide from:body -> window.ermiteWide.toggle();
503 k-expand from:body -> ermite.expandFile();
504 k-expandAll from:body -> ermite.expandAll();
505 k-permalink from:body -> ermite.permalink();
506 k-merge from:body -> window.ermiteMR?.openMerge();
507 k-read from:body -> window.ermiteMR?.markRead();
508 k-gf from:body -> window.ermiteMR?.focusFiles();
509 k-keys from:body -> ermite.toggleKeys()">
510</div>
511</body>
512</html>