Overview#
You can easily embed asciinema casts on the Developer Portal. asciinema allows you to record terminal sessions using a lightweight text-based format.
Notable features#
- Copy text and commands directly from the video
- Add Markers similar to Youtube chapters
- Edit casts by manipulating the file contents or using asciinema-edit
Word of caution#
Use asciinema casts for output logs or to demonstrate things in action. Avoid using asciinema casts for interactive guides as many users prefer scrolling through commands and copying them from code snippets instead of fishing the commands out of an asciinema cast.
Usage#
How to upload and embed a cast#
- Install asciinema and record a terminal session following the Quick start guide.
- Edit the
.castfile if required. - Add the .cast file in the same directory as your page.
- Add a Hugo shortcode to your page:
{{< asciinema key=“demo” idleTimeLimit=“2” speed=“1.5” poster=“npt:0:09” >}}- The file added is
demo.cast - See also the asciinema player options
- The file added is
The above shortcode will be rendered as follows:
How to embed a cast from asciinema.org#
You can embed a cast hosted on asciinema.org:
- Under the video, click the Share button
- Copy the code snippet provided under Embed the player and paste where needed, for example
<script src=“ https://asciinema.org/a/342851.js" id=“asciicast-342851” async=“true”></script>
The above shortcode will be rendered as follows: