Readable documentation
Documentation tables: escaping, captions and readable headers
A useful table explains the relationship between headings and values. Code generation should preserve those values while making the structure explicit.
Content updated: · Maintainer and corrections
Treat imported cells as text
Keep leading zeros, quoted delimiters and multiline CSV fields as text. A cell containing <script> or Markdown syntax is not permission to execute or interpret it. The HTML export escapes cell content rather than injecting imported markup.
GFM tables are a Markdown extension, not a universal format. Pipes and line breaks need deliberate handling; another renderer may display the same output differently. Inspect the published document, especially when cells contain code-like characters or multiple lines.
Provide a caption and meaningful headings
Use a caption to identify the table and th elements with column scope for a simple header row. A visible title outside a table does not always provide the same programmatic relationship. Avoid blank or misleading column names.
This generator targets simple data tables, not page layout or complex spanning headers. Keep wide tables in an accessible scrolling region and verify keyboard, zoom and assistive-technology behavior in the destination document. Escaped HTML alone is not complete accessibility certification.
Data provenance