# Markdown

> A plain-text guide to Markdown, the lightweight format for writing formatted
> text that converts straight to HTML. Covers the core syntax, the common
> extensions, and the tools for writing and converting Markdown.

## Pages

- [Home](https://markdown.org/): overview and what each section covers.
- [Syntax](https://markdown.org/syntax/): the reference hub for how Markdown
  syntax works, with links into the basics, HTML markup, cheat sheet and
  compatibility pages.
- [Basics](https://markdown.org/basics/): the core syntax, covering headings,
  paragraphs, line breaks, formatting (bold, italic, strikethrough, underline,
  colour, comments), lists, images, links and code, blockquotes and horizontal
  rules, with side-by-side examples.
- [HTML markup](https://markdown.org/html/): using raw HTML inside Markdown,
  covering what the tags look like, colours, accordions (details/summary), image sizing,
  and a table of which HTML tags work on CommonMark, GitHub, GitLab, Obsidian,
  VS Code and Reddit.
- [Cheat sheet](https://markdown.org/cheat-sheet/): a one-page quick reference
  of every core element and its syntax, plus escaping special characters.
- [Compatibility](https://markdown.org/compatibility/): a feature-by-processor
  table, grouped into basic, advanced and extension features, showing which
  Markdown features work across CommonMark, GitHub, Obsidian, VS Code, Reddit
  and Pandoc.
- [Extensions](https://markdown.org/extensions/): an index of extensions
  beyond the core, including GitHub Flavored Markdown, tables, task lists, footnotes,
  math (LaTeX/KaTeX), diagrams and charts (Mermaid, PlantUML, Graphviz,
  Vega-Lite), admonitions/callouts, definition lists, front matter, table of
  contents, emoji and more.
- [Tools](https://markdown.org/tools/): free in-browser Markdown tools, with a
  page for each.
  - [Editors](https://markdown.org/tools/editors/): live Markdown editor, table
    editor, presentations, multi-file workspace.
  - [Diagrams](https://markdown.org/tools/diagrams/): flowchart, sequence, class,
    state, ER/database, gantt, mind map and many more, plus visual editors for
    freeform shapes, floorplans and circuits.
  - [Converters](https://markdown.org/tools/converters/): Markdown to and from
    HTML, PDF, Word, images, data tables and chat formats.
  - [Formatters](https://markdown.org/tools/formatters/): table of contents, README and
    badge generators, formatter, linter, stripper.
- [Apps](https://markdown.org/apps/): a directory of tools, including online
  editors (Dillinger, StackEdit, HackMD), desktop apps for macOS/Windows/Linux
  (Obsidian, Typora, MarkText, Zettlr, iA Writer, VS Code), mobile apps
  (iOS/Android) and command-line converters (Pandoc, markdownlint, Glow).
- [Developers](https://markdown.org/developers/): Markdown parsing and
  rendering libraries grouped by language.
  - [JavaScript](https://markdown.org/developers/javascript/): markdown-it,
    marked, remark, micromark.
  - [Python](https://markdown.org/developers/python/): Python-Markdown,
    markdown-it-py, mistune, mistletoe.
  - [Ruby](https://markdown.org/developers/ruby/): kramdown, Redcarpet,
    CommonMarker.
  - [PHP](https://markdown.org/developers/php/): league/commonmark, Parsedown.
  - [Go](https://markdown.org/developers/go/): goldmark, gomarkdown,
    Blackfriday.
  - [Rust](https://markdown.org/developers/rust/): pulldown-cmark, comrak.
  - [Java / JVM](https://markdown.org/developers/java/): commonmark-java,
    flexmark-java.
  - [C / C++](https://markdown.org/developers/c/): cmark, MD4C.
  - [.NET](https://markdown.org/developers/dotnet/): Markdig.
  - [Swift](https://markdown.org/developers/swift/): swift-markdown.
  - [Haskell](https://markdown.org/developers/haskell/): Pandoc, cmark.

## Notes

- Markdown support varies by processor; most follow the CommonMark spec and
  differ mainly in which extensions they bundle.