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<link rel="icon" type="image/svg+xml" href="/-/static/img/icon.HASH.svg">
9<link rel="preload" href="/-/static/fonts/atkinson-next.HASH.woff2" as="font" type="font/woff2" crossorigin>
10<link rel="stylesheet" href="/-/static/css/ermite.HASH.css">
11<meta name="htmx-config" content='{"history":false,"includeIndicatorCSS":false,"extensions":"sse, hx-live"}'>
12<script src="/-/static/js/htmx.min.HASH.js" defer>
13</script>
14<script src="/-/static/js/hx-live.min.HASH.js" defer>
15</script>
16<script src="/-/static/js/hx-sse.min.HASH.js" defer>
17</script>
18<script src="/-/static/js/ermite.HASH.js" defer>
19</script>
20<script src="/-/static/js/files.HASH.js" defer>
21</script>
22<script src="/-/static/js/passkey.HASH.js" defer>
23</script>
24<script src="/-/static/js/log.HASH.js" defer>
25</script>
26</head>
27<body data-ref="main" data-sha="SHA40" data-sel="" data-nav="" data-paths="/files/paths/SHA40" data-blob="/files/blob/main">
28<a class="skip" href="#main">skip to content</a>
29<header class="hdr">
30<div class="hdr-top">
31<a class="brand" href="/" data-g="h" title="home (g h)">
32<span class="brand-mark" aria-hidden="true">
33</span>
34<span class="brand-name">example.test</span>
35</a>
36<nav class="crumbs" aria-label="Path">
37<ol>
38<li>
39<a href="/files">files</a>
40</li>
41<li>
42<a href="/files/tree/main">blob</a>
43</li>
44<li>
45<a href="/files/tree/main">main</a>
46</li>
47<li>
48<a href="/files/tree/main/docs">docs</a>
49</li>
50<li>
51<a href="/files/blob/main/docs/guide.md" aria-current="page">guide.md</a>
52</li>
53</ol>
54</nav>
55<div class="hdr-acts">
56<a class="btn ref" href="/files/refs" data-fire="refs" aria-keyshortcuts="b" title="switch branch or tag (b)">
57<span class="ico i-branch" aria-hidden="true">
58</span>
59<span class="ref-name">main</span>
60<span class="sha">SHA7</span>
61</a>
62<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">
63<span class="ico i-search" aria-hidden="true">
64</span>
65<span class="search-label">Go to…</span>
66<kbd aria-hidden="true">ctrl k</kbd>
67</button>
68<button type="button" class="btn icon" data-js data-fire="help" aria-haspopup="dialog" aria-controls="panel-help" aria-keyshortcuts="?" aria-label="Keyboard shortcuts" title="keyboard shortcuts (?)">?</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 has-rail">
101<main id="main" tabindex="-1">
102<h1 class="file-h">
103<span>guide.md</span>
104<span class="acts">
105<a class="btn" href="/files/raw/main/docs/guide.md">Raw</a>
106<a class="btn" href="/files/commits/main/docs/guide.md">History</a>
107<a class="btn" href="/files/tree/main/docs">Folder</a>
108</span>
109</h1>
110<article class="prose" aria-label="guide.md" hx-ignore>
111<h1 id="md-guide">Guide</h1>
112<h2 id="md-steps">Steps</h2>
113<p>Run it.</p>
114<pre>
115<code class="language-sh">make all
116</code>
117</pre>
118</article>
119<details class="source">
120<summary>source</summary>
121<pre class="chroma code" data-anchor="" hx-on:click="let a = event.target.closest('a.ln'); if (!a) return; event.preventDefault();
122 let n = +a.textContent; if (!event.shiftKey || !data.anchor) data.anchor = n;
123 let lo = Math.min(+data.anchor, n), hi = Math.max(+data.anchor, n);
124 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;
125 q('.line in this').arr().forEach(l => { let k = +l.id.slice(1); l.classList.toggle('sel', k >= lo && k <= hi) });
126 document.body.dataset.sel = lo ? 'L' + lo + (hi > lo ? '-L' + hi + ' · ' + (hi - lo + 1) + ' lines' : '') : '';
127 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="">
128<code hx-ignore>
129<span class="line" id="L1">
130<a class="ln" href="#L1">1</a>
131<span class="gh"># Guide</span>
132</span>
133<span class="line" id="L2">
134<a class="ln" href="#L2">2</a>
135</span>
136<span class="line" id="L3">
137<a class="ln" href="#L3">3</a>
138<span class="gu">## Steps</span>
139</span>
140<span class="line" id="L4">
141<a class="ln" href="#L4">4</a>
142</span>
143<span class="line" id="L5">
144<a class="ln" href="#L5">5</a>Run it.</span>
145<span class="line" id="L6">
146<a class="ln" href="#L6">6</a>
147</span>
148<span class="line" id="L7">
149<a class="ln" href="#L7">7</a>
150<span class="s">```sh</span>
151</span>
152<span class="line" id="L8">
153<a class="ln" href="#L8">8</a>make all</span>
154<span class="line" id="L9">
155<a class="ln" href="#L9">9</a>
156<span class="s">```</span>
157</span>
158</code>
159</pre>
160</details>
161</main>
162<aside class="rail" aria-label="Context">
163<section aria-labelledby="r-file">
164<h2 id="r-file">File</h2>
165<dl class="kv">
166<dt>size</dt>
167<dd>47 B</dd>
168<dt>lines</dt>
169<dd>9</dd>
170<dt>type</dt>
171<dd>markdown</dd>
172</dl>
173</section>
174<section aria-labelledby="r-last">
175<h2 id="r-last">Last change <a href="/files/commits/main/docs/guide.md">History</a>
176</h2>
177<p>
178<a href="/files/commit/SHA40">SHA7</a> add docs/guide.md</p>
179<p class="dim">T · <time datetime="STAMP" title="STAMP">AGO</time>
180</p>
181</section>
182<section aria-labelledby="r-outline">
183<h2 id="r-outline">On this page</h2>
184<nav class="outline" aria-label="Outline">
185<a class="l1" href="#md-guide">Guide</a>
186<a class="l2" href="#md-steps">Steps</a>
187</nav>
188</section>
189<section aria-labelledby="r-sel">
190<h2 id="r-sel">Selection</h2>
191<p :text="document.body.dataset.sel || 'none · click a line number, shift-click extends'">none · click a line number, shift-click extends</p>
192<p class="dim">y copies a permalink pinned to the commit sha</p>
193</section>
194</aside>
195</div>
196<footer class="foot">
197<span>ermite devel</span>
198<a href="http://example.test/ermite" rel="noopener" title="source of this version (AGPL-3.0-or-later)">source</a>
199<span class="foot-keys">
200<kbd>?</kbd> keyboard shortcuts</span>
201</footer>
202<div class="hint" role="status" aria-live="polite">
203<span class="hint-nav" :text="document.body.dataset.nav || ''">
204</span>
205<span class="hint-sel" :text="document.body.dataset.sel ? document.body.dataset.sel + ' · y permalink' : ''">
206</span>
207<span class="hint-flash" :text="document.body.dataset.flash || ''">
208</span>
209</div>
210<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()">
211<div class="panel-head">
212<h2>Keyboard shortcuts</h2>
213<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
214<kbd>esc</kbd> close</button>
215</div>
216<dl class="keys">
217<div>
218<dt>
219<kbd>ctrl k</kbd>
220<kbd>:</kbd>
221</dt>
222<dd>go to a section, branch, tag, file or repository</dd>
223</div>
224<div>
225<dt>
226<kbd>?</kbd>
227</dt>
228<dd>this list</dd>
229</div>
230<div>
231<dt>
232<kbd>j</kbd>
233<kbd>k</kbd>
234</dt>
235<dd>move the row cursor down / up</dd>
236</div>
237<div>
238<dt>
239<kbd>enter</kbd>
240</dt>
241<dd>open the row under the cursor</dd>
242</div>
243<div>
244<dt>
245<kbd>g g</kbd>
246<kbd>G</kbd>
247</dt>
248<dd>first / last row</dd>
249</div>
250<div>
251<dt>
252<kbd>/</kbd>
253</dt>
254<dd>filter the list; on Files, find a file in the repository</dd>
255</div>
256<div>
257<dt>
258<kbd>b</kbd>
259</dt>
260<dd>switch branch or tag</dd>
261</div>
262<div>
263<dt>
264<kbd>s</kbd>
265<kbd>t</kbd>
266<kbd>c</kbd>
267<kbd>r</kbd>
268<kbd>m</kbd>
269</dt>
270<dd>tabs: summary, files, commits, branches & tags, merge requests</dd>
271</div>
272<div>
273<dt>
274<kbd>g h</kbd>
275</dt>
276<dd>home</dd>
277</div>
278<div>
279<dt>
280<kbd>y</kbd>
281</dt>
282<dd>copy a permalink pinned to the commit</dd>
283</div>
284<div>
285<dt>
286<kbd>d</kbd>
287<kbd>u</kbd>
288<kbd>x</kbd>
289</dt>
290<dd>diff: split / unified / collapse or expand all</dd>
291</div>
292<div>
293<dt>
294<kbd>n</kbd>
295</dt>
296<dd>merge request: next note in the diff</dd>
297</div>
298<div>
299<dt>
300<kbd>esc</kbd>
301</dt>
302<dd>close a dialog, leave a field</dd>
303</div>
304</dl>
305</dialog>
306<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()">
307<div class="panel-head">
308<label for="refs-filter" class="sr">filter branches and tags</label>
309<input id="refs-filter" type="search" placeholder="Switch branch or tag…" autocomplete="off" data-pick="#panel-refs li" hx-on:input="ermite.filter(this)">
310<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
311<kbd>esc</kbd>
312</button>
313</div>
314<div class="panel-cols" data-picklist>
315<section aria-label="Branches">
316<h2>Branches <span class="count">2</span>
317</h2>
318<ul>
319<li>
320<a href="/files/tree/feature/x">
321<span class="mark" aria-hidden="true"> </span>feature/x</a>
322</li>
323<li>
324<a href="/files/tree/main" aria-current="true">
325<span class="mark" aria-hidden="true">●</span>main</a>
326</li>
327</ul>
328</section>
329<section aria-label="Tags">
330<h2>Tags <span class="count">1</span>
331</h2>
332<ul>
333<li>
334<a href="/files/tree/v1.0">
335<span class="mark" aria-hidden="true"> </span>v1.0</a>
336</li>
337</ul>
338</section>
339</div>
340</dialog>
341<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()">
342<div class="panel-head">
343<label for="cmd-q" class="sr">go to</label>
344<input id="cmd-q" type="search" placeholder="Go to a section, branch, tag, file or repository…" autocomplete="off" spellcheck="false" aria-controls="cmd-list" hx-on:input="ermite.cmdFilter(this); ermiteFinder.palette(this)" hx-on:keydown="ermite.cmdKey(event)">
345<button type="button" class="panel-x" aria-label="Close" hx-on:click="closest('dialog').close()">
346<kbd>esc</kbd>
347</button>
348</div>
349<ul id="cmd-list" class="cmd-list" aria-label="Targets">
350<li data-k="go home" data-cursor>
351<a href="/" tabindex="-1">
352<span class="lbl">home</span>
353<span class="k">go</span>
354</a>
355</li>
356<li data-k="section summary">
357<a href="/files" tabindex="-1">
358<span class="lbl">summary</span>
359<span class="k">section</span>
360</a>
361</li>
362<li data-k="section files">
363<a href="/files/tree/main" tabindex="-1">
364<span class="lbl">files</span>
365<span class="k">section</span>
366</a>
367</li>
368<li data-k="section commits">
369<a href="/files/commits/main" tabindex="-1">
370<span class="lbl">commits</span>
371<span class="k">section</span>
372</a>
373</li>
374<li data-k="section branches & tags">
375<a href="/files/refs" tabindex="-1">
376<span class="lbl">branches & tags</span>
377<span class="k">section</span>
378</a>
379</li>
380<li data-k="section merge requests">
381<a href="/files/merge-requests" tabindex="-1">
382<span class="lbl">merge requests</span>
383<span class="k">section</span>
384</a>
385</li>
386<li data-k="section actions">
387<a href="/files/actions" tabindex="-1">
388<span class="lbl">actions</span>
389<span class="k">section</span>
390</a>
391</li>
392<li data-k="branch feature/x">
393<a href="/files/tree/feature/x" tabindex="-1">
394<span class="lbl">feature/x</span>
395<span class="k">branch</span>
396</a>
397</li>
398<li data-k="branch main">
399<a href="/files/tree/main" tabindex="-1">
400<span class="lbl">main</span>
401<span class="k">branch</span>
402</a>
403</li>
404<li data-k="tag v1.0">
405<a href="/files/tree/v1.0" tabindex="-1">
406<span class="lbl">v1.0</span>
407<span class="k">tag</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-esc from:body -> ermite.closeDialogs();
427 k-help from:body -> ermite.dialog('panel-help');
428 k-refs from:body -> ermite.dialog('panel-refs', 'refs-filter');
429 k-cmd from:body -> ermite.dialog('panel-cmd', 'cmd-q'); ermiteFinder.load();
430 k-filter from:body -> ermite.focusFilter();
431 k-gh from:body -> ermite.go('.brand');
432 k-s from:body -> ermite.tab('s');
433 k-t from:body -> ermite.tab('t');
434 k-c from:body -> ermite.tab('c');
435 k-r from:body -> ermite.tab('r');
436 k-m from:body -> ermite.tab('m');
437 k-next from:body -> ermite.nextNote();
438 k-split from:body -> ermite.layout('split');
439 k-unified from:body -> ermite.layout('unified');
440 k-collapse from:body -> ermite.collapse();
441 k-permalink from:body -> ermite.permalink()">
442</div>
443</body>
444</html>