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

Resolve the path relative to the Markdown document location. A reference from docs/guide.md to ./images/architecture.png expects docs/images/architecture.png. Moving the document can break that relationship. Check spelling and letter case, especially when moving from a Windows machine to a case-sensitive host.

![Architecture overview](./images/architecture.png)

Check the destination behavior

Open the resolved image URL directly. A login page returning HTTP 200 is still not an image. Local disk paths are not generally accessible to a hosted browser editor or another reader. Package assets with the document or choose a stable public URL you have permission to publish.

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.