- 01Inspect the source
- 02Check the renderer
- 03Verify the destination
Each step answers a different question. Verify the final document in its actual destination.
Find the smallest failing example
Under CommonMark, a single newline inside a paragraph is a soft break. A renderer can display it as a space. An empty line creates a separate paragraph. For an intentional hard break, use a backslash at the end of a line or two trailing spaces. A visible backslash can be easier to review because formatters sometimes remove trailing whitespace.
First line\
Second line
A separate paragraph.Check the destination behavior
GitHub repository files and discussion fields do not always use identical newline behavior. Markups enables a parser breaks option, so its preview may differ from a strict CommonMark renderer. Test a saved document in the destination where readers will see it.
A repeatable debugging sequence
- Save the failing source before editing it.
- Remove surrounding content until a few lines reproduce the symptom.
- Compare that sample with the destination documentation.
- Change one thing at a time and check both source and output.
- Restore the surrounding document and inspect the delivered version.
This separates syntax errors from missing renderer features and inaccessible files. An example that works in one preview can still fail in the final publishing workflow.
Keep the repair portable
Record any required renderer extensions beside the example. Keep essential meaning in ordinary paragraphs and retain the editable original. Check links, assets and formatting after moving the file. Previewing locally helps diagnose the source; the final check belongs where people will actually read it.
When a preview tool helps
A side-by-side preview makes small source changes easier to inspect. Markups is one option for trying the example, but its renderer settings can differ from the publishing destination. Compare the destination output before considering the problem solved.
Sources and related reading
Primary syntax documentation and the CommonMark and GFM compatibility guide.