Quickstart

Install the package

First, make sure to install the package in your Astro project.

Import the recording, then pass it to Asciinema:

---
import { Asciinema } from "astro-asciinema";
import Demo from "../recordings/demo.cast";
---

<Asciinema src={Demo} />

import { Asciinema } from "astro-asciinema"
import Demo from "../recordings/demo.cast"

<Asciinema src={Demo} />

Pass any Asciinema player option through options:

<Asciinema
	src={Demo}
	options={{
		autoPlay: true,
		controls: true,
		cursorMode: "hidden",
		speed: 2,
	}}
/>

Read Theme watching when your custom terminal theme follows the site’s light and dark modes.
See the Component reference for all component props.