Markdown Preview

Markdown Formatting Guide

Markdown is a lightweight markup language created by John Gruber that allows you to write formatted text using a plain text editor. It converts easily to HTML and is widely used for README files, documentation, forum posts, and static site generation.

Basic Syntax

• Headings — Use # through ###### for heading levels. # Title is the largest, ###### is the smallest.
• Bold and italic — Wrap text with **double asterisks** for bold, *single asterisks* for italic, and ***triple*** for bold italic.
• Links — Format as [link text](url) to create clickable hyperlinks.
• Images — Use ![alt text](image-url) to embed images in your document.
• Code — Use backticks `code` for inline code and triple backticks ``` for code blocks.
• Blockquotes — Precede text with > to create a quoted block, useful for citing sources.
• Lists — Use - or * for unordered lists and numbers for ordered lists.

Where Markdown is Used

• GitHub and GitLab — README.md files, issue descriptions, pull request descriptions, and wiki pages all use Markdown.
• Static site generators — Tools like Jekyll, Hugo, and Next.js use Markdown for content authoring.
• Note-taking apps — Obsidian, Notion, and Bear support Markdown for rich text notes.
• Documentation — Many documentation frameworks (MkDocs, Docusaurus, ReadTheDocs) use Markdown as their source format.