Skip to content

Restore the table borders lost in the APT conversion - #3424

Merged
slachiewicz merged 1 commit into
masterfrom
site-table-borders
Aug 10, 2026
Merged

slachiewicz merged 1 commit into
masterfrom
site-table-borders

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

Follow-up to #3422, which merged before this fix could be included.

The problem

A Markdown pipe table renders as class="table table-striped". The APT tables these two pages came from rendered as class="table table-bordered table-striped", so the conversion quietly dropped the cell borders on:

  • maven-surefire-plugin/src/site/markdown/examples/toolchains.md.vm
  • surefire-api/src/site/markdown/index.md

I reported this in #3422 as a limitation of the Markdown sink that could not be controlled from the source document. That was wrong β€” it is true of a pipe table, but not of the source in general.

The fix

Doxia parses a raw HTML <table> back into the same table it built from APT: the class and the per-cell style survive verbatim, and it still applies the alternating tr class="a"/"b" itself. Writing these two tables out as HTML restores the original rendering exactly.

Verification

Compared against the pre-conversion site, on the same three axes used for #3422 β€” document title, author and date metadata plus visible text and link targets; block structure including <pre> and <table> classes; and heading anchors:

  • examples/toolchains.html drops out of all three axes entirely. It is now an exact match for the APT baseline, table-bordered and style="text-align: left;" and all.
  • surefire-api/index.html's only remaining difference is the two Term/Definition header cells, which were added deliberately in Convert the remaining site documentation from APT to MarkdownΒ #3422 because a Markdown table cannot express a headerless one.

What is deliberately left alone

maven-surefire-plugin/src/site/markdown/history.md.vm keeps its Markdown table. It carries 24 links and 38 line breaks across nine rows, and it is the changelog that gains a row every release β€” handing maintainers hand-written HTML in the file they edit most often, to gain a border, is the wrong trade. That page keeps table table-striped.

Generated-by: Claude Opus 5 (1M context)

A Markdown pipe table renders as class="table table-striped"; the APT
tables these two pages came from rendered as
class="table table-bordered table-striped", so the conversion in #3422
quietly dropped the cell borders.

Doxia parses a raw HTML table back into the same table it built from
APT -- the class and the per-cell style survive verbatim and it still
applies the alternating row classes itself -- so writing these two out
as HTML restores the original rendering exactly.

Verified against the pre-conversion site: examples/toolchains now
matches the APT baseline on every axis compared, and the only remaining
difference on surefire-api/index is the Term and Definition header
cells, which were added deliberately in #3422 because a Markdown table
cannot express a headerless one.

history.md.vm keeps its Markdown table on purpose.  It carries 24 links
and 38 line breaks across nine rows and gains a row every release, so
readable source is worth more there than the border.

Generated-by: Claude Opus 5 (1M context)
@slachiewicz slachiewicz added documentation Improvements or additions to documentation master labels Aug 10, 2026
@slachiewicz
slachiewicz marked this pull request as ready for review August 10, 2026 00:47
@slachiewicz
slachiewicz merged commit 77765c2 into master Aug 10, 2026
17 of 18 checks passed
@slachiewicz
slachiewicz deleted the site-table-borders branch August 10, 2026 00:47
@github-actions github-actions Bot added this to the 3.6.0-M2 milestone Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation master

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant