Skip to content

Twitter

Embeds tweets with configurable theme, alignment, and width. Accepts twitter.com and x.com references in several forms (full URL, scheme-less, or a bare user/status/id), canonicalizing the output to twitter.com.

Usage

import markdown

md = markdown.Markdown(extensions=["markwright.twitter"])
html = md.convert("[twitter https://twitter.com/User/status/123]")

See Using with MkDocs to load it in a MkDocs site.

Syntax

[twitter URL flags...]
Parameter Default Description
URL required Tweet reference: a full URL, a scheme-less URL, or a bare user/status/id (twitter.com or x.com)

Accepted URL forms

All of these resolve to the same tweet:

[twitter https://twitter.com/User/status/123]
[twitter https://x.com/User/status/123]
[twitter twitter.com/User/status/123]
[twitter User/status/123]

Flags

Flag Description
light Light theme (default)
dark Dark theme
left Left-align the tweet
center Center-align (default)
right Right-align the tweet
integer Width in pixels (clamped 250-550, default: 550)

Examples

Basic Tweet

[twitter https://twitter.com/github/status/1234567890]

Dark Theme, Left-Aligned

[twitter https://twitter.com/github/status/1234567890 dark left]

Custom Width

[twitter https://twitter.com/github/status/1234567890 400]

Load Mode

The load option decides when the embed contacts the provider. Set it in markwright.toml, or pass it through extension_configs in-process.

Value Output
eager (default) The live embed, with the provider script injected once per page.
click An inert preview with a load button and a direct link; no provider script. 
[twitter]
load = "click"

md = markdown.Markdown(
    extensions=["markwright.twitter"],
    extension_configs={"markwright.twitter": {"load": "click"}},
)

See Click-to-Load for the preview markup and a host script that swaps in the live embed.

Notes

  • The embed must be on its own line
  • x.com URLs are automatically converted to twitter.com
  • Width is clamped to 250-550px (Twitter's supported range)
  • The Twitter widgets script is injected once per page, and only when at least one embed is eager