📝Writing

Markdown: The Fastest Way to Format Text Anywhere

Markdown is 20 years old and used everywhere — GitHub, Notion, Slack, VS Code, Reddit. Here's everything you need to know in 5 minutes.

5 min readFebruary 9, 2026By FreeToolKit TeamFree to read

Markdown is everywhere and once you know it, you can write formatted content faster than any rich text editor. GitHub READMEs, Notion pages, Slack messages, technical documentation — the same syntax works in all of them.

The Essential Syntax

  • # Heading 1, ## Heading 2, ### Heading 3
  • **bold text**, *italic text*, ***bold and italic***
  • [Link text](https://url.com)
  • ![Alt text](image-url.jpg) — images
  • - or * for unordered lists, 1. for numbered lists
  • `inline code`, ```code block``` (triple backtick)
  • > for blockquote
  • --- for horizontal rule

Code Blocks With Syntax Highlighting

Triple backticks with a language identifier give you syntax highlighting in most platforms: ```javascript followed by code then ```. Common identifiers: javascript, python, bash, sql, typescript, json, yaml. GitHub, GitLab, and most documentation platforms apply syntax highlighting automatically.

Tables

Markdown tables are functional if not elegant to write: | Name | Value | on the first line, | --- | --- | on the separator line, then data rows. Table generators (like tablesgenerator.com) let you build tables visually and copy the Markdown. For complex tables, using HTML directly inside Markdown is valid in most renderers.

Task Lists (GitHub Flavored Markdown)

- [ ] unchecked item and - [x] checked item render as interactive checkboxes in GitHub issues and PRs. Useful for PR descriptions listing what's included, release checklists, and project tracking inside GitHub issues.

Editor tip

VS Code renders Markdown previews with Ctrl+Shift+V. Typora (paid) and Obsidian (free for local files) are standalone Markdown editors with live preview. For quick formatting checks, paste into our Markdown Preview tool.

Frequently Asked Questions

What is Markdown?+
Markdown is a lightweight text formatting syntax created by John Gruber in 2004. You write formatting instructions inline with the text using simple punctuation: *asterisks* for italics, **double asterisks** for bold, # for headings. The text is readable as-is and converts to formatted HTML. It's used in GitHub, GitLab, Notion, Obsidian, Slack, Discord, Reddit, Stack Overflow, and most modern documentation systems.
Do different platforms support different Markdown?+
Yes, and this is a common source of confusion. CommonMark is the standardized specification that most platforms follow for basic syntax. GitHub Flavored Markdown (GFM) adds tables, task lists, and automatic URL linking. Obsidian and Notion add proprietary extensions for internal links and embeds. For basic formatting (headings, bold, links, code), all major platforms are compatible. For tables and advanced features, check the specific platform's documentation.
Should I write documentation in Markdown or a rich text editor?+
Markdown for technical documentation. Rich text editors for non-technical audiences who need visual editing. Markdown's advantages for docs: version control-friendly (plain text diffs cleanly in git), portable (no vendor lock-in), fast to write with keyboard shortcuts, and consistently formatted. The disadvantage: non-technical stakeholders may struggle with syntax. Most documentation platforms (GitBook, Docusaurus, Readme.com) render Markdown and often provide rich text editors as alternatives.
How do I add a table in Markdown?+
Tables use pipes and hyphens: | Header 1 | Header 2 | on the first line, | --- | --- | on the second line (separating headers from content), then | Cell 1 | Cell 2 | for each row. Alignment is controlled by colons in the separator row: | :--- | for left, | ---: | for right, | :---: | for center. Most editors render the table visually, so you can see it as you type.

🔧 Free Tools Used in This Guide

FT

FreeToolKit Team

FreeToolKit Team

We build free browser-based tools and write practical guides that skip the fluff.

Tags:

markdownwritingdeveloperformatting