docs: backtick-quote angle-bracket placeholders in prose - they vanish in HTML renderers #315

New issue

Closed

opened 2026-07-21 02:34:58 +00:00 by hexajon · 0 comments

hexajon commented

2026-07-21 02:34:58 +00:00

(Migrated from codeberg.org)

docs/reference/cli-git.md writes placeholders as raw angle-bracket tokens in prose - e.g. "commits ahead of mainline (<mainlineref>..HEAD)", 3 occurrences on that page. Any renderer that passes HTML through (goldmark with unsafe, most site pipelines) treats <mainlineref> as an unknown element and hides it; on madtea.lol readers see "(..HEAD)" with the placeholder text missing.

Fix wherever the text actually lives - help strings / generator templates for the generated pages, the markdown itself for hand-written ones: placeholders in prose get backtick-quoted (`<mainlineref>`) so they render as inline code everywhere.

Worth a sweep for other bare <token> shapes in prose across docs/** while at it.

Acceptance: no bare angle-bracket placeholder tokens in prose anywhere in the docs; the cli-git page shows <mainlineref> as inline code.

`docs/reference/cli-git.md` writes placeholders as raw angle-bracket tokens in prose - e.g. "commits ahead of mainline (<mainlineref>..HEAD)", 3 occurrences on that page. Any renderer that passes HTML through (goldmark with unsafe, most site pipelines) treats `<mainlineref>` as an unknown element and hides it; on madtea.lol readers see "(..HEAD)" with the placeholder text missing. Fix wherever the text actually lives - help strings / generator templates for the generated pages, the markdown itself for hand-written ones: placeholders in prose get backtick-quoted (`` `<mainlineref>` ``) so they render as inline code everywhere. Worth a sweep for other bare `<token>` shapes in prose across `docs/**` while at it. Acceptance: no bare angle-bracket placeholder tokens in prose anywhere in the docs; the cli-git page shows `<mainlineref>` as inline code.

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

sixfold-space/madtea#315

No description provided.

Rows
Columns