Review Markdown Warnings Before Publishing
Admin ·
A Markdown document can parse successfully and still publish something unexpected. Check the dialect your destination uses, then look at the lines where it might read an intended link, table or code block differently.
Read the four CommonMark findings
Select Load example and Check Markdown with CommonMark selected. Line 3 starts a table that is recognized as a GFM extension. The reference on line 7 stays as text because its definition is missing. The second reference definition on line 10 repeats the one on line 9. The fence beginning on line 12 reaches the end without a closing fence.
An unclosed fence still forms a valid CommonMark block. Add a closing fence if the lines that follow it should return to ordinary prose.
CommonMark 0.31.2 fenced code block behaviorCommonMark link reference definition rulesGitHub Flavored Markdown table rules
Switch to GitHub Flavored Markdown for the table
Switch Markdown dialect to GitHub Flavored Markdown and check again. There are still four findings. The table warning now points to line 5 because the Review row contains one cell while the header has two. GFM adds an empty second cell when it renders the row.
Add a second cell to line 5, define missing, remove the extra reference definition, and close the code fence. Recheck under GFM to clear the example’s findings.
GitHub Flavored Markdown table rulesCommonMark link reference definition rules
Keep the report with the source you reviewed
Download the report and check its dialect heading and source positions. If you edit the document after saving it, rerun the check so that the line numbers match the current source.
A clean report means the checks found none of these authoring patterns. Confirm the resulting document in your destination when it has its own extensions, HTML rules or link handling.
CommonMark 0.31.2 fenced code block behaviorGitHub Flavored Markdown table rules
Common questions
Will a bracketed word trigger a missing reference warning?
The check looks for simple explicit references such as [label][id] and collapsed forms such as [label][]. A standalone bracketed word may be literal text.
Why does the report warn about raw HTML?
A target renderer may alter or remove HTML that CommonMark recognizes. Verify the destination’s formatting and sanitization if the HTML is necessary.