Learn
Everything about Markdown, with examples.
Each page shows the syntax next to the result, and says where it works and where it does not.
Markdown syntax
Markdown syntaxMarkdown cheat sheetMarkdown marks up plain text with a few characters: # for headings, * for emphasis and lists, [text](url) for links, backticks for code. GitHub Flavored Markdown adds tables, task lists, strikethrough and autolinks.Markdown syntaxMarkdown tablesA Markdown table is a header row, a delimiter row of dashes, and body rows, with cells separated by pipes (|). Colons in the delimiter row set the alignment. Tables are a GitHub Flavored Markdown extension, not core CommonMark.Markdown syntaxMarkdown code blocksWrap inline code in single backticks. For a block, put a line of three backticks before and after the code, and add a language name after the opening fence for syntax highlighting.Markdown syntaxMarkdown listsStart a line with -, * or + for a bullet, or with a number and a period for a numbered item. To nest a list, indent it so it lines up with the text of the parent item: two spaces under a bullet, three under 1.Markdown syntaxMarkdown task listsA task list item is a normal list item that starts with [ ] for an open task or [x] for a done one, followed by a space. Task lists are a GitHub Flavored Markdown extension, so they only render as checkboxes in apps that support GFM.Markdown syntaxMarkdown links and imagesA link is [text](url). An image is the same with an exclamation mark in front: . Reference links move the URL out of the sentence, and relative paths link to other files in the same folder or repository.
Mermaid diagrams
Mermaid diagramsMermaid flowchartsStart a fenced code block with mermaid, write flowchart TD (or LR) on the first line, then one node or link per line, like A[Start] --> B{OK?}.Mermaid diagramsMermaid sequence diagramsWrite sequenceDiagram on the first line, then one message per line in the form Sender->>Receiver: text. Use -->> for replies and loop, alt or opt blocks for logic.Mermaid diagramsMermaid Gantt chartsWrite gantt on the first line, set a dateFormat, then list tasks as Name :id, start, duration. Use after id to chain tasks and milestone for key dates.
Markdown on a Mac
Markdown on a MacHow to open .md files on a MacAny text app can open a .md file, but only an editor preview or a Markdown viewer shows it formatted. To change the default app, select the file, choose Get Info, pick an app under Open With and click Change All.Markdown on a MacMarkdown to PDF on a MacThe quickest free way is to open the file in a tool that renders Markdown and use Print, then PDF ▸ Save as PDF. For repeatable or styled output, use pandoc or a VS Code extension.
Read your Markdown in MarkkoFree on the Mac App Store. Quick Look, live reload and themes included.
Coming soon to the Mac App Store