Markdown
A friendly guide to Markdown, the plain-text writing format. It covers the basic syntax, the extensions that add tables, diagrams and maths, and the best tools for every platform.
Markdown Reference
The site includes guides for writing basic Markdown and for working with the different formats, from CommonMark and GitHub to Obsidian, Notion, Slack and Pandoc, and a set of converters between these different formats.
- Basics - Every core rule, with what you type beside what it renders
- Compatibility - Which syntax works in CommonMark, GitHub, Obsidian, VS Code, Reddit, Notion, Slack and Pandoc
- Extensions - GitHub Flavored Markdown, tables, task lists, footnotes, diagrams and maths
- HTML in Markdown - Underline, colour, accordions and image sizing where Markdown has no mark of its own
- Blocks - The block types, and every type of Mermaid diagram
- Cheat sheet - Every element and its syntax on one page
Editors
There is an overall Markdown editor, plus an editor for each of the common diagram types, including everything Mermaid can draw. Each diagram editor shows the diagram as you build it: click any part of it to select it, and its details appear in the Properties panel, ready to change.
Markdown editor
Write the text, or build the document from blocks. The + between two blocks opens a menu of everything that can go there, from paragraphs and tables to every type of diagram. Open the Markdown editor ↗
Flowchart
Boxes, decisions and the arrows between them. The selected decision's label, shape, parent and order are in the Properties panel. Open the flowchart editor ↗
Sequence diagram
Participants and the messages that pass between them. The selected message's sender, arrow, receiver and text are in the Properties panel. Open the sequence diagram editor ↗
Class diagram
Classes, their members and how they relate. The selected class's name, generic type, annotation and members are in the Properties panel. Open the class diagram editor ↗
ER diagram
Database tables, their fields and the relationships between them. The selected entity's name, alias and fields are in the Properties panel. Open the ER diagram editor ↗
Mind map
Ideas branching out from a central one. The selected node's text, shape and children are in the Properties panel. Open the mind map editor ↗
Converters
Converters take Markdown to and from other formats, in both directions. Each one runs in the browser, so nothing is uploaded.
Markdown to PDF
A print-ready PDF from a Markdown file.
Markdown to Word
A Word document from a Markdown file.
Word to Markdown
Word documents to Markdown, with images, lists, tables, links and footnotes.
PDF to Markdown
PDF files to Markdown, with lines and paragraphs rebuilt from the page layout.
HTML to Markdown
Web pages and HTML to clean Markdown.
Markdown to Confluence
Confluence wiki markup, ready to paste into a page on Cloud or Server.
Contents
The sections of markdown.org, and the pages in each.
Technologies
- JavaScript - The editors, diagram editors and converters, all running in the browser
- Mermaid - Drawing the diagrams
Credits
- Piotr Nierobisz - Testing & improvements
More guides
- GPU Guide - GPU prices across shops, cloud GPU hosting and GPU programming
- MicroPython - Python 3 for microcontrollers, with examples to run in a playground