Markdown Syntax Guide for Developers
Learn Markdown formatting — headings, links, lists, code blocks, and how to convert Markdown to HTML.
Markdown is a lightweight markup language used in README files, documentation, GitHub issues, Notion exports, and static site generators. It converts easily to HTML while staying readable as plain text.
Essential syntax
- # Heading 1, ## Heading 2, ### Heading 3
- **bold** and *italic* text
- [link text](https://url.com) for hyperlinks
- - item for unordered lists
- `inline code` for code snippets
- ```code block``` for multi-line code
When to use Markdown
- GitHub README and wiki pages
- Static site generators (Hugo, Jekyll, Astro)
- API and project documentation
- Blog posts and technical writing