Question 1

What is a GFM pipe table?

Accepted Answer

A GitHub-Flavored Markdown (GFM) pipe table is a table syntax using vertical pipe characters (|) as column separators, a header row, and a mandatory separator row of dashes below the header that indicates column alignment. GFM tables are supported by GitHub, GitLab, VS Code preview, Notion, Obsidian, and most modern Markdown renderers. They are not part of the original CommonMark spec but are widely adopted as a de facto extension.

Question 2

What do the alignment separator patterns mean?

Accepted Answer

The separator row (second row of a Markdown table) uses dash sequences to separate columns and colons to indicate alignment. ':---' means left-align; ':---:' means center-align; '---:' means right-align; '---' (no colons) also means left by default. The number of dashes doesn't matter — ':--' and ':----' both mean the same thing — but longer sequences improve readability by matching the column content width.

Question 3

Why is my import not working?

Accepted Answer

The parser expects a standard GFM pipe table with at least two lines: a header row and a separator row. Common issues: (1) The separator row is missing or uses invalid characters — each cell must be only dashes and optional colons (e.g. ':---' or ':---:'). (2) Lines are missing pipe characters at the start or end — while some renderers tolerate this, the parser requires pipes on both sides. (3) There are blank lines inside the table — the parser stops at the first blank line.

Question 4

Does this tool handle escaped pipes inside table cells?

Accepted Answer

Escaped pipes (\|) inside cell content are not currently handled by the built-in parser, as they are rare and require lookahead logic. If your table contains literal pipe characters inside cells, enclose them in code spans (\`|\`) or use HTML entities (&#124;). This is consistent with how GitHub itself renders Markdown tables — the pipe character is the column delimiter and cannot appear unescaped in cell content.

Question 5

Can I use this for documentation tables?

Accepted Answer

Yes — this tool is designed exactly for documentation workflows. Write your table visually, copy the Markdown output, and paste it directly into GitHub READMEs, GitLab wikis, Confluence pages (with Markdown support), Notion, Obsidian, or any documentation system that renders GFM. The generated output is correctly padded for readability in source view, not just rendered view.

Markdown Table Generator,
visual editor with instant GFM output.

Markdown

Paste existing table

GitHub-Flavored Markdown tables explained.

Table anatomy

Alignment syntax

Where GFM tables are supported

Best practices for documentation tables


HDR
1
2
3