https://arran4.github.io/header/docs/Recent content in Documentation on header — website metadata toolkitHugoen-ushttps://arran4.github.io/header/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://arran4.github.io/header/docs/getting-started/<h1 id="getting-started">Getting started<a class="anchor" href="#getting-started" aria-label="Link"></a></h1> <p><strong>Goal:</strong> Install <code>header</code>, extract metadata from a URL, and inspect the result.</p> <h2 id="prerequisites">Prerequisites<a class="anchor" href="#prerequisites" aria-label="Link"></a></h2> <p>Install a supported Go toolchain (Go 1.26 or later to build from source) and have network access to a webpage. Alternatively, download a compatible binary from <a href="https://github.com/arran4/header/releases">GitHub Releases</a> when available.</p> <h2 id="install">Install<a class="anchor" href="#install" aria-label="Link"></a></h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>go install github.com/arran4/header/cmd/header@latest</span></span></code></pre></div><p>Check the installed command:</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>header --help</span></span></code></pre></div><h2 id="extract-metadata">Extract metadata<a class="anchor" href="#extract-metadata" aria-label="Link"></a></h2> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>header extract --style json https://example.com</span></span></code></pre></div><p>This requests the page and prints the extracted metadata in JSON. The actual fields depend on the remote page and can change as its content changes.</p>https://arran4.github.io/header/docs/contributing/Mon, 01 Jan 0001 00:00:00 +0000https://arran4.github.io/header/docs/contributing/<h1 id="contributing">Contributing<a class="anchor" href="#contributing" aria-label="Link"></a></h1> <p>The project is written in Go. Build from a checkout with Go 1.26 or later.</p> <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-text-size-adjust:none;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>go test ./... </span></span><span style="display:flex;"><span>go test -race -count<span style="color:#f92672">=</span><span style="color:#ae81ff">1</span> ./... </span></span><span style="display:flex;"><span>go vet ./... </span></span><span style="display:flex;"><span>go generate ./...</span></span></code></pre></div><p>Generated command sources under <code>cmd/</code> are produced from definitions under <code>internal/cli/</code> using the pinned <code>gosubc</code> dependency. Review <a href="https://github.com/arran4/header/blob/main/AGENTS.md">AGENTS.md</a> and the <a href="https://github.com/arran4/header/blob/main/internal/generate/README.md">generation notes</a> before changing commands.</p> <h2 id="documentation">Documentation<a class="anchor" href="#documentation" aria-label="Link"></a></h2> <p>The documentation source lives in <code>docs/</code> and uses Hugo Book as a pinned submodule. Preview with:</p>