PROVIDER Β· the most universal lightweight markup language
Markdown
Markdown expresses structure in plain text with minimal symbols, serving as the source for READMEs, technical docs, and blogs where Git plus static site frameworks add versioning and multi-format output.
Pros
Cons
Product Information
Detailed Notes
Overview
Markdown was created by John Gruber with Aaron Swartz in 2004, expressing headings, emphasis, links, and code through symbols like #, *, and brackets in plain text, with CommonMark standardising it from 2014 and GitHub's GFM adding tables, task lists, and autolinks.
For Programming Languages & Frameworks work the value is decoupling content from tooling, since READMEs, technical docs, blogs, and API notes almost all use Markdown, one source renders to web, PDF, or slides, and Git gives documents version history with pull request review.
Note the limits, because the standard and extensions have long diverged across CommonMark, GFM, MDX, and platform dialects making tables and footnotes render differently, complex layout such as multi-column or precise typesetting is impossible without HTML, and large document trees need static site frameworks.
Core Strengths
- Plain text syntax works in any editor with almost no learning cost
- Pairs naturally with Git giving docs version history and review
- One source renders to web, PDF, slides, and more
- Natively supported by code hosts, doc platforms, and static site frameworks
Product Ecosystem
Core syntax
Headings, lists, emphasis, links, images, quotes, code blocks, and rules.
Extensions
GFM tables and task lists, footnotes, KaTeX maths, and MDX embedded components.
Toolchain
Static site frameworks like Docusaurus, VitePress, and Astro plus pandoc and Prettier.
Drawbacks
- Standards and extensions diverge with inconsistent rendering
- Complex layout and precise positioning require HTML
- Large document trees need extra frameworks for navigation
- Teams must agree on a dialect to avoid confusion
Use Cases
- Technical docs and READMEs (β β β β β ) - The industry standard
- Blogs and knowledge bases (β β β β β ) - Plain text friendly
- Static site content (β β β β β ) - Framework native
- Precision typesetting and print (β β ) - Needs professional tools
Pricing
| Plan | Price | Scope |
|---|---|---|
| Markdown and CommonMark | $0 | Open specification, free |
| Renderers and static site tools | $0 | Open source and free |
| Hosted documentation platforms | From $0 | Free tiers or usage billing |
The specification and tooling are free with near-zero cost, where the only investment is agreeing a dialect, ideally CommonMark with GFM, and enforcing format through Prettier or markdownlint in CI.
FAQ
-
Does Markdown have a standard? Yes, CommonMark is the de facto specification with GitHub's GFM extending it, though small dialect differences remain.
-
Can it do complex tables? Basic tables work while merged cells need HTML or MDX components.
-
How does it compare with Word? Markdown suits technical docs, READMEs, and version-controlled content while contracts and fine typesetting stay in Word or InDesign.
Code Examples
Common syntax
# Data center prices
| Data center | Price | Route |
| --- | --- | --- |
| Hong Kong | 99 | CN2 GIA |
| US | 59 | CN2 GT |
- **bold**, *italic*, `inline code`
- [link](https://16idc.com)
- Fence code blocks and tag the language
Tables, lists, and fenced code are the three most used constructs in technical writing.
A README outline
## Install
npm install
## Usage
See the [docs](https://example.com/docs).
## Contributing
Issues and PRs are welcome.
Indented code blocks work in most renderers while fenced blocks with a language tag are more portable.
Community & Resources
Communities and official channels
- CommonMark Spec β The most widely implemented standard
- GitHub commonmark-spec β Spec source and discussion
- Stack Overflow #markdown β Rendering and escaping answers
Learning resources and tools
- Markdown Guide β Cheat sheet and best practice
- CommonMark Specification β The full normative text
- Pandoc β Convert Markdown to any format