Skip to content
Docs

The body as Markdown

markdown is the same body as html, written as standard Markdown: CommonMark with GitHub’s extras (tables, strikethrough and alerts). Any Markdown tool that reads GitHub’s flavour reads it back as the same article.

Use it when you want to draw the article with your own components, for example with MDX, react-markdown, marked or Astro’s renderer.

article.markdown
**Brew green tea at 80°C for two minutes. Hotter water makes it bitter.**
## Why temperature matters
Boiling water pulls out more tannins, which taste **bitter**. See our [tea guide](/blog/tea-guide).
> [!TIP]
> No thermometer? Let boiled water stand for three minutes.
1. Heat the water to 80°C.
2. Steep for two minutes.
3. Pour and serve.
| Tea | Temperature |
| - | - |
| Green | 80°C |
| Black | 95°C |
## Frequently asked questions
### Can I use boiling water?
You can, but the tea will taste bitter.
## Sources
1. [Brewing temperatures](https://example.org/brewing), Example Tea Board
Part Markdown
Answer One bold paragraph at the top.
Key takeaways A bold “Key takeaways” line, then a list.
Sections ## to #### headings.
Lists - for bullets, 1. for steps, sub-items indented one level.
Tables GitHub’s pipe tables.
Callouts GitHub’s alerts: a quote that starts > [!TIP], [!NOTE], [!IMPORTANT], [!WARNING] or [!CAUTION].
Quotes A > quote, then a line starting with a dash for who said it.
Images ![alt](src "caption"), the caption as the image’s title.
Videos A link to the video, with its title as the words.
Code A fenced block with its language. The fence is longer than any fence inside it.
FAQ A “Frequently asked questions” ##, then a ### for each question.
Sources A “Sources” ##, then a numbered list of links with their publishers.
  • No contents list. The HTML body can carry one; the Markdown never does, since most renderers make their own.
  • No class names. Callouts are GitHub’s alerts, so a renderer needs alert support (or a small plugin) to draw them as boxes. Without it they show as ordinary quotes.
  • Videos are links. There is no player in Markdown.

The title and cover are left out of both, as in the HTML.