Markdown Cheatsheet - Markdown Syntax Reference
Markdown is not difficult to write; it is difficult to be sure what it will look like elsewhere. GitHub renders tables and some documentation sites do not; some platforms drop task lists and others strip inline HTML. This sheet places widely supported syntax alongside platform-specific extensions, organised by headings, text styling, lists, code blocks, links and images, and tables with horizontal rules, marking clearly which forms are universal and which only work in some places. The selection rule is consistent: prefer universal syntax, because the small convenience an extension adds becomes rework the moment the document moves. Where an extension is genuinely needed - task lists, autolinks - at least confirm the target supports it and keep a plain-text fallback in mind. Copying a document between a docs site and a repository README is where transformation actually bites, and three spots account for most of it: line breaks inside tables, code blocks that themselves contain fences, and URLs containing special characters.
Heading 5
# H1## H2### H3Title
===Title
---Text Style 7
**bold***italic****bold italic***~~strikethrough~~`inline code`> quote> > nested quoteList 5
- Unordered item1. Ordered item- [ ] Todo- [x] Done - Indented sub-itemCode Block 4
```python``` 4-space indent code```{bash eval=true}Link & Image 5
[text](https://example.com)[text](https://example.com "title")[text][ref]
[ref]: https://example.com[text](#anchor-id)Table & HR 5
---| Col1 | Col2 |
| --- | --- |
| a | b || :--- || :---: || ---: |Tips
- Use <br> for line breaks inside tables — Markdown tables don't support native line breaks.
- When backticks conflict inside code blocks, use more backticks for fencing (e.g., ~~~~ around content containing ```).
- GFM (GitHub Flavored Markdown) supports task lists, strikethrough, auto-links, and tables — more features than standard Markdown.
FAQ
My Markdown image uses a relative path but breaks after publishing — why?
Relative paths resolve against the Markdown file's own directory, so images under ./images referenced as  only render if they are deployed too and the site does not rewrite URLs. In GitHub repos relative paths work but are case-sensitive; for documentation sites on an image CDN, use the full URL instead.
How do I put a pipe or line break inside a Markdown table cell?
Columns are separated by pipes, so escape a literal pipe inside a cell as \|. For a line break use <br>; a natural Markdown line break collapses to a space inside a cell. Keep cells short and prefer blockquotes or lists for heavier layout.
Do I need to specify the language for a Markdown code block?
Wrap code in triple backticks and put the language right after, e.g. ```javascript, for highlighting. Some platforms also accept four-space indented blocks, and single backticks are for inline code. Common identifiers like javascript, typescript, bash, json and python are recognized by most engines.
How do I write long links or reference-style links in Markdown?
Inline is [text](https://...), but long URLs clutter the doc. Reference-style links define [key]: https://... in a link list once and use [text][key] anywhere, so changing one URL updates every reference. Bare URLs are auto-linked on many sites.
Why does my Markdown look fine locally but break on GitHub?
Each platform parses a slightly different dialect. GitHub uses GFM with task lists, autolinks, @mentions and table highlighting, but is stricter about blank lines and indentation and sanitizes some raw HTML. Local previews differ too, especially around line breaks. Stick to portable core syntax (brackets, asterisks, backticks) and preview on the target platform before publishing.
Official References
Each command links to its official documentation below, so you can verify the latest usage and read deeper.
Maintained by LaoHand
Publicly updated on Jul 21, 2026, continuously proofread against official docs.
Contact Us
Wrong command or description? Send us corrections, business inquiries or product feedback by email.
Contact Us