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.

Choose the structure for your readers

Math is a renderer extension, so delimiters and commands depend on the application. Define variables, units and assumptions in ordinary prose before introducing the equation. A formula alone rarely explains the reasoning.

A small example to try

Inline: $E = mc^2$

Display:
$$
x = \frac{a}{b}
$$

Paste this example into the editor and compare the source with its preview. Change one element at a time so you can identify which syntax controls the result.

Check compatibility before sharing

Markups uses KaTeX. Check its supported-functions reference before relying on LaTeX packages or custom macros. Reduce failing formulas to a minimal expression. Test inline math, display math and unusual commands in the final destination. Markups PDF output is image-based; preserve your original Markdown.

A practical review checklist

  1. Check headings and labels explain the content without extra context.
  2. Test the example in the destination where people will read it.
  3. Verify links and relative asset paths after moving the file.
  4. Inspect exported documents separately from the live preview.
  5. Keep the editable Markdown original alongside distributed copies.

Primary source and further reading

Read the specification or project documentation. Explore the complete Markdown guide and Compatibility Lab.

All Markdown articles