Embed · ReadMe

Embed an interactive demo in ReadMe docs.

Put a Tellane lane in a ReadMe guide with an HTMLBlock — ReadMe pages are MDX, so the iframe rides inside the block's template string. Exact syntax included.

Where it goes: A getting-started guide or feature page in a ReadMe developer hub, so readers click through the workflow the docs describe.

The snippet

One iframe

The share modal generates this for your lane; the example uses a placeholder address. ReadMe needs the variant below it.

<iframe src="https://acme.tellane.com/l/pipelines-tour" width="100%" height="640" frameborder="0" allowfullscreen></iframe>
<HTMLBlock>{`
<iframe src="https://acme.tellane.com/l/pipelines-tour"
  width="100%" height="640" style="border:0"
  allowfullscreen loading="lazy" title="Interactive demo"></iframe>
`}</HTMLBlock>

Steps

In ReadMe

  1. In Tellane, open the lane → Share → copy the public link.
  2. In the ReadMe editor, place the cursor where the player should appear and write an HTMLBlock component (ReadMe pages are MDX; paste the block below).
  3. Save and view the published page, then drive the lane once.

Proof

This is what the embed looks like

A lane embedded on this page, the same way yours will be on ReadMe. Drive it.

osprey.app/pipelines — captured with Tellane
LIVE DEMO
Osprey
Overview
Pipelines
Accounts
Reports
Settings
PIPELINES / Q3

Q3 enterprise pipeline

Invite teammate
Open pipeline$4.2M +12%
Win rate31% +4pts
Avg. cycle24d −6d
Weekly closed-wonJun — Aug
Meridian FreightNegotiation$380K
Cobalt HealthProposal$210K
Aster & Co.Discovery$95K
THIS PAGE EATS ITS OWN DOG FOOD
You're looking at a real Tellane demo.

Osprey is a fictional app we captured in five minutes. Click the glowing dots to drive it yourself — three stops, no sales call.

Lane progress
Embedded lane · the same player ReadMe will show

If it doesn't work

What breaks, and the fix

  • The editor reports an MDX or JSX error. Keep the iframe inside the HTMLBlock's backtick template string exactly as shown — outside it, MDX parses the HTML as JSX and plain-HTML attributes like allowfullscreen fail.
  • A 'Made with Tellane' badge shows on the demo. Free-plan lanes carry the badge; Growth removes it under Settings → Workspace.

FAQ

Questions

Why HTMLBlock instead of a plain iframe?

ReadMe pages are MDX, which treats bare HTML as strict JSX. The HTMLBlock component exists to carry raw HTML verbatim — ReadMe's own docs use it the same way.

Other platforms

Embed guides

EmbedWebflowEmbedWordPressEmbedFramerEmbedNotionEmbedHubSpot CMSEmbedWixEmbedSquarespaceEmbedGhostEmbedDocusaurusEmbedConfluenceEmbedZendesk GuideEmbedEmail (Gmail, Outlook, HubSpot, Mailchimp)EmbedBubbleEmbedCarrdEmbedGitBookEmbedWebflow CMS collectionsEmbedIntercom ArticlesDocsPublishing, sharing, and embedding