Readme has html embedded #196

Closed
opened 2026-09-08 13:56:30 +00:00 by crueber · 3 comments
Owner

This html is embedded at the top of the readme file

# walhub

A git host in Go: **git over smart HTTP (v0/v2), LFS, bundle-uri, a JSON API with SSE, and a web UI — where the object store is the only database.**

It serves repositories whose entire state — refs, packs, config, policy, events, web UI — lives as
objects in a bucket (filesystem, S3, or GCS). Instances are disposable; wipe one and you lose nothing
but warmth.

<p align="center">
  <a href="docs/img/repo-overview.png"><img src="docs/img/repo-overview.png" width="32%" alt="Repository overview: refs, file tree, clone"></a>
  <a href="docs/img/code-view.png"><img src="docs/img/code-view.png" width="32%" alt="Blob view with syntax highlighting"></a>
  <a href="docs/img/setup.png"><img src="docs/img/setup.png" width="32%" alt="Setup: labels left, fields right, working examples under every label"></a>
</p>

That needs to be changed to markdown. No embedded HTML in markdown files.

This html is embedded at the top of the readme file ```markdown # walhub A git host in Go: **git over smart HTTP (v0/v2), LFS, bundle-uri, a JSON API with SSE, and a web UI — where the object store is the only database.** It serves repositories whose entire state — refs, packs, config, policy, events, web UI — lives as objects in a bucket (filesystem, S3, or GCS). Instances are disposable; wipe one and you lose nothing but warmth. <p align="center"> <a href="docs/img/repo-overview.png"><img src="docs/img/repo-overview.png" width="32%" alt="Repository overview: refs, file tree, clone"></a> <a href="docs/img/code-view.png"><img src="docs/img/code-view.png" width="32%" alt="Blob view with syntax highlighting"></a> <a href="docs/img/setup.png"><img src="docs/img/setup.png" width="32%" alt="Setup: labels left, fields right, working examples under every label"></a> </p> ``` That needs to be changed to markdown. No embedded HTML in markdown files.
Author
Owner

Fixed by PR #198 (branch fix/issue-196, currently open, not merged).

What changed (README.MD only): the <p align="center"> screenshot block → three stacked [![alt](src)](href) paragraphs; the <p><sub> caption → an italic line. Alt text and link targets are byte-identical; width="32%" has no markdown equivalent (noted in the PR).

Verified: node --test 397/397 green; replacement renders through render-md.js (raw-endpoint images, blob-view links per #182/#185, all tags/attrs inside the pinned DOMPurify gate); real-Chromium check against a live server — all 3 images load dark+light, links navigate, caption readable, zero console errors.

Also in the PR description: a repo-wide scan for other embedded HTML (report only — docs/go/12_web_ui.md:34 is a fenced code sample, everything else is inline code spans; nothing else renders as HTML).

Fixed by PR #198 (branch `fix/issue-196`, currently open, not merged). What changed (README.MD only): the `<p align="center">` screenshot block → three stacked `[![alt](src)](href)` paragraphs; the `<p><sub>` caption → an italic line. Alt text and link targets are byte-identical; `width="32%"` has no markdown equivalent (noted in the PR). Verified: `node --test` 397/397 green; replacement renders through `render-md.js` (raw-endpoint images, blob-view links per #182/#185, all tags/attrs inside the pinned DOMPurify gate); real-Chromium check against a live server — all 3 images load dark+light, links navigate, caption readable, zero console errors. Also in the PR description: a repo-wide scan for other embedded HTML (report only — `docs/go/12_web_ui.md:34` is a fenced code sample, everything else is inline code spans; nothing else renders as HTML).
Author
Owner

Review of PR #198 (fix/issue-196, commit 2f38dc7) — README HTML block to markdown. Verified in scratch worktree (removed afterward); main worktree untouched.

CHECKS (all pass):

  • Diff is README.MD only (6+/4-); no other file touched.
  • Zero embedded HTML: grep for <p|<a|<img|<sub|<div outside fenced code blocks is clean; no such tags anywhere in the file.
  • alt/href/src byte-identical to old block: same 3 alts ('Repository overview: refs, file tree, clone' / 'Blob view with syntax highlighting' / 'Setup: labels left, fields right, working examples under every label'), same 3 srcs and outer hrefs (docs/img/repo-overview.png, code-view.png, setup.png). No broken targets.
  • Caption preserved verbatim as italic (...), previously .
  • docs/img/{repo-overview,code-view,setup}.png all exist.
  • Stacked-vs-table: stacked is sane. A markdown table would gain nothing — GitHub tables have no width-attr equivalent either, so pipes would add syntax for zero visual control. Only deliberate loss is width=32pct side-by-side and center alignment, which have no markdown equivalent (that is the point of the issue).
  • Rendered the new block through the repo's own marked pipeline (web/node_modules marked@18.0.11, ESM): emits 3x with correct targets plus caption. Correct.
  • Full node suite in scratch worktree: node --test web/test/unit/*.test.js -> 397 pass, 0 fail.

No browser run (README-only change; rendering verified via marked + reasoning instead). No fixes needed — nothing to push.

MERGE RECOMMENDATION: ready to merge.

Review of PR #198 (fix/issue-196, commit 2f38dc7) — README HTML block to markdown. Verified in scratch worktree (removed afterward); main worktree untouched. CHECKS (all pass): - Diff is README.MD only (6+/4-); no other file touched. - Zero embedded HTML: grep for <p|<a|<img|<sub|<div outside fenced code blocks is clean; no such tags anywhere in the file. - alt/href/src byte-identical to old block: same 3 alts ('Repository overview: refs, file tree, clone' / 'Blob view with syntax highlighting' / 'Setup: labels left, fields right, working examples under every label'), same 3 srcs and outer hrefs (docs/img/repo-overview.png, code-view.png, setup.png). No broken targets. - Caption preserved verbatim as italic (*...*), previously <sub>. - docs/img/{repo-overview,code-view,setup}.png all exist. - Stacked-vs-table: stacked is sane. A markdown table would gain nothing — GitHub tables have no width-attr equivalent either, so pipes would add syntax for zero visual control. Only deliberate loss is width=32pct side-by-side and center alignment, which have no markdown equivalent (that is the point of the issue). - Rendered the new block through the repo's own marked pipeline (web/node_modules marked@18.0.11, ESM): emits 3x <a href><img src alt></a> with correct targets plus <em> caption. Correct. - Full node suite in scratch worktree: node --test web/test/unit/*.test.js -> 397 pass, 0 fail. No browser run (README-only change; rendering verified via marked + reasoning instead). No fixes needed — nothing to push. MERGE RECOMMENDATION: ready to merge.
Author
Owner

Fixed by PR #198 (review clean; zero HTML, targets byte-identical; 397/397), merged. Closing.

Fixed by PR #198 (review clean; zero HTML, targets byte-identical; 397/397), merged. Closing.
crueber added this to the v1 milestone 2026-09-10 22:27:14 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
crueber/walhub#196
No description provided.