About Markdown

Markdown is a lightweight markup language created by John Gruber and Aaron Swartz in 2004. It allows you to write formatted text using a simple, readable plain-text syntax that can be converted to HTML and other formats. Markdown has become the standard for writing documentation, README files, blog posts, and comments on platforms like GitHub, Stack Overflow, and Reddit.

Markdown Syntax Reference

Here are the most commonly used Markdown elements:

• Headings: Use # for h1, ## for h2, up to ###### for h6.
• Bold: Wrap text in **double asterisks** or __double underscores__.
• Italic: Wrap text in *single asterisks* or _single underscores_.
• Code: Use `backticks` for inline code or triple backticks for code blocks.
• Links: [display text](url) creates a clickable link.
• Images:  embeds an image.
• Lists: Start lines with - or * for unordered lists, or 1. for ordered lists.
• Blockquotes: Start a line with > to create a blockquote.
• Horizontal rule: Use --- on its own line.

Where Markdown Is Used

• GitHub: README files, issues, pull requests, and comments all support Markdown.
• Documentation: Tools like MkDocs, Docusaurus, and VuePress use Markdown files as source content.
• Blogging: Static site generators like Hugo, Jekyll, and Astro use Markdown for blog posts.
• Note-taking: Apps like Obsidian, Notion, and Bear use Markdown or Markdown-like syntax.
• Communication: Slack, Discord, and many forums support Markdown formatting.

Markdown Flavors

While the original Markdown specification covers the basics, several extended versions (flavors) have added features:

• GitHub Flavored Markdown (GFM): Adds tables, task lists, strikethrough, and autolinked URLs.
• CommonMark: A strict specification that resolves ambiguities in the original Markdown syntax.
• MDX: Allows embedding JSX components inside Markdown, used in modern React documentation sites.