A practical mental model
  1. 01Inspect the source
  2. 02Check the renderer
  3. 03Verify the destination

Each step answers a different question. Verify the final document in its actual destination.

Find the smallest failing example

Align nested content with the parent item content and keep that alignment consistent. Required indentation depends on the marker width and following spaces; one fixed number is not a universal rule for every numbered item. Spaces make indentation easier to review than tabs displayed at different widths.

1. Prepare the draft
   - Check links
   - Review examples
2. Publish the result

Check the destination behavior

Reduce the example to one parent item, one child and one continuation paragraph. Empty lines can change a tight list into a loose list with paragraph spacing. If a code block belongs inside the item, align its fence with the parent content. Restore the rest one block at a time.

A repeatable debugging sequence

  1. Save the failing source before editing it.
  2. Remove surrounding content until a few lines reproduce the symptom.
  3. Compare that sample with the destination documentation.
  4. Change one thing at a time and check both source and output.
  5. 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.