{# canonical_base is the OWNING tenant's origin: all 16 Peasy domains serve the same catalogue, so a page rendered by a non-owner points its canonical at the owner instead of competing with it. Falls back to this site for static/self-owned pages. #}
🍋
Menu
How-To Beginner 1 min read 261 words

Markup Language Formats: HTML, Markdown, reStructuredText, and AsciiDoc

Compare lightweight markup languages for documentation, blogging, and technical writing. Understand the expressiveness, tooling support, and ideal use cases for each format.

Key Takeaways

  • Markup languages span a spectrum from minimal (Markdown) to comprehensive (HTML).
  • Markdown dominates because of ecosystem support — GitHub, GitLab, VS Code, Notion, and thousands of tools understand it natively.
  • Markdown lacks built-in support for footnotes, definition lists, table spanning, and cross-referencing.
  • Markdown**: READMEs, blog posts, simple documentation

The Markup Spectrum

Markup languages span a spectrum from minimal (Markdown) to comprehensive (HTML). Lightweight markup languages sacrifice some expressiveness for readability — the source text is pleasant to read even without rendering. The right choice depends on your content complexity and tooling ecosystem.

Feature Comparison

Feature Markdown reStructuredText AsciiDoc HTML
Learning curve Very low Medium Medium High
Tables Basic Complex supported Complex supported Full
Cross-references Extension Built-in Built-in Manual
Admonitions Extension Built-in Built-in Manual
Math Extension Built-in (LaTeX) Built-in MathML
Extensibility Flavors vary Directives Macros Unlimited

Markdown: The Universal Choice

Markdown dominates because of ecosystem support — GitHub, GitLab, VS Code, Notion, and thousands of tools understand it natively. Its simplicity is both its strength and limitation. For basic documentation, README files, and blog posts, Markdown is the obvious choice.

When Markdown Falls Short

Markdown lacks built-in support for footnotes, definition lists, table spanning, and cross-referencing. Various 'flavors' (GFM, CommonMark, MDX) extend it inconsistently. For book-length technical documentation with complex structure, AsciiDoc or reStructuredText provides the features Markdown lacks.

Choosing Your Format

  • Markdown: READMEs, blog posts, simple documentation
  • reStructuredText: Python project documentation (Sphinx)
  • AsciiDoc: Technical books, complex documentation with cross-references
  • HTML: When you need full control over presentation