Markdown Cheat Sheet

THE PRACTICAL GUIDE · NORMANDIN SYSTEMS

Get more from Markdown Cheat Sheet

Markdown Cheat Sheet summarizes common text conventions for headings, emphasis, lists, links, code, and other document structure. Markdown is interpreted by a renderer, and extensions such as tables or task lists are not universal. A useful document remains readable as plain text while rendering clearly in the application where it will be published. A cheatsheet works best as a memory aid while you practice a concrete task. Read the command or syntax together with its arguments, placeholders, and surrounding context. Similar-looking options can have very different meanings, and an example written for one platform or version may need adjustment elsewhere. Keep the reference beside a small test case, use read-only examples first when possible, and check the relevant help output before applying an unfamiliar command to valuable files or a running service.

Guide updated October 13, 2026

How to use this tool

1. Identify the operation you want to perform and find the matching section of the reference. Read the whole example before copying any part of it.
2. Choose the syntax element you need and preview a small sample in the same renderer used by the destination.
3. Review the example below and compare its expected behavior with a small sample of your own input before continuing.
4. Try the adapted example on a small test case, compare the result with the explanation, and save the command with a note about the context in which it works.

SEE IT IN PRACTICE

A worked example

## Project notes

A second-level heading reading Project notes

The leading hashes identify heading level in common Markdown syntax, giving the document a visible hierarchy.

Renderer differences are part of the format

Common Markdown syntax covers headings, lists, emphasis, links, and code, while features such as tables, task lists, or embedded HTML depend on the renderer. Check the final publishing environment when those extensions matter. Blank lines and indentation influence block structure, so a list nested inside another element can render differently from a visually similar plain-text layout. Keep the document readable before rendering and use preview feedback to confirm structure instead of adding arbitrary spacing until one view looks right.

Code and links need deliberate escaping

A code fence should contain the example exactly as readers need it, and the fence itself must be chosen so it does not close prematurely inside the example. Link labels should explain the destination, while URLs and parentheses may require careful syntax. Check heading hierarchy rather than using heading levels only for font size. A concise, well-structured Markdown document is easier to maintain than one that relies heavily on renderer-specific HTML for ordinary formatting tasks.

When this tool is useful

• Format a README section
• Review Markdown link and code syntax
• Prepare a document that remains readable as plain text

Tips for a better result

• Check heading order, code fences, links, list nesting, and special characters in the destination preview.
• Replace example paths, identifiers, and names deliberately. Copying a reference command unchanged can target a different file, branch, service, or environment from the one you intended.
• Keep the source and the settings used for this result together. That makes a later comparison or correction easier, especially when another person needs to reproduce the same outcome.

Frequently asked questions