xyd 0.1.0-alpha - Coming Soon

Integrations
/
Other apps
/
Supademo

Supademo

The Supademo integration allows you to embed interactive demos in your documentation. This enables visitors to try out your product or API directly within your docs, providing a hands-on experience that enhances understanding and engagement.

You can still use embedded version of Supademo. Then you don't need this integration.

Configuration

To enable the Supademo integration, add the following configuration to your docs.json:

{
"integrations": {
".apps": {
"supademo": {
"apiKey": "YOUR_API_KEY"
}
}
}
}

Example

Embed interactive product demos in your documentation. Users can click the demo button to see an interactive tour.

<span data-supademo-demo="YOUR_DEMO_ID">
:::button
View Demo
:::
</span>

Alternatively you can use Supademo() API inside MDX Components.

Reference

  • apiKey
    string
    Required
    The Supademo API key

Analytics

Track how users interact with your demos through automatic analytics events.

Event nameCustom propertiesDescription
supademo.loadDemo
-
When a Supademo loads.
Github StarEdit Link
Built with

Show your support! Star us on GitHub ⭐️