Skip to content

docs: ensure footnotes work in raw HTML types table#115

Merged
lidavidm merged 1 commit into
adbc-drivers:mainfrom
amoeba:docs/fix-footnotes-in-html-table
Nov 25, 2025
Merged

docs: ensure footnotes work in raw HTML types table#115
lidavidm merged 1 commit into
adbc-drivers:mainfrom
amoeba:docs/fix-footnotes-in-html-table

Conversation

@amoeba

@amoeba amoeba commented Nov 25, 2025

Copy link
Copy Markdown
Contributor

What's Changed

This is the necessary fix to make footnotes work correctly in our generated validation pages. Before this, footnotes didn't work when the footnote reference was inside a raw HTML table without special handling. The special handling is to add blank lines around the templates and ensure the cell content isn't indented any more than myst-parser tolerates. Apparently this is 0-3 spaces. Once you indent it to 4 spaces, footnotes break. Maybe a ReST thing?

For this change, we just don't indent and surround with blank lines.

Closes #114

@amoeba
amoeba requested a review from lidavidm as a code owner November 25, 2025 16:34

@lidavidm lidavidm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 spaces in Markdown = code block. (I think people don't use this much anymore, but IIRC the original inventor liked it better than the triple-backtick since it hews closer to his original vision of having the markup itself look good.)

@lidavidm
lidavidm merged commit af49749 into adbc-drivers:main Nov 25, 2025
3 checks passed
@amoeba

amoeba commented Nov 25, 2025

Copy link
Copy Markdown
Contributor Author

4 spaces in Markdown = code block. (I think people don't use this much anymore, but IIRC the original inventor liked it better than the triple-backtick since it hews closer to his original vision of having the markup itself look good.)

Ah, yeah. I think I've blocked that from my memory and Gruber did indeed put it in the spec. Something that confused me was that I thought "interpreting as raw HTML" would imply footnote processing would be totally disabled between the start end of the block.

@lidavidm

Copy link
Copy Markdown
Contributor

It's apparently in the spec/would explain why the first attempt at adding blank lines wouldn't work (examples 183 and 184, "The opening tag can be preceded by up to three spaces of indentation, but not four"): https://spec.commonmark.org/0.31.2/#example-183

@amoeba

amoeba commented Nov 26, 2025

Copy link
Copy Markdown
Contributor Author

Ah, yeah. Good thinking to be looking there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix how footnote references work in raw HTML tables

2 participants