SpecsModelExplore
Tables and Footnotes
Tables and Footnotes

Reference for Markdown tables and footnotes syntax used in IOModel specifications.

Tables are useful for compact comparisons; footnotes help keep prose readable.

Table example

Source syntax

| Environment | Base URL                | Auth Method |
| ----------- | ----------------------- | ----------- |
| Dev         | https://dev.example.com | API Key     |
| Staging     | https://stg.example.com | OAuth       |
| Prod        | https://api.example.com | OAuth       |

Rendered output

EnvironmentBase URLAuth Method
Devhttps://dev.example.comAPI Key
Staginghttps://stg.example.comOAuth
Prodhttps://api.example.comOAuth

Footnote example

Source syntax

The export job is eventually consistent.[^export-delay]

[^export-delay]: Most exports complete in under 2 minutes.

Rendered output

The export job is eventually consistent.

Most exports complete in under 2 minutes.

Guidance

  • Keep table columns short and scannable.
  • Avoid deeply nested content inside table cells.
  • Use footnotes for detail, not critical instructions.

Last updated on