chore: add asciinema guidelines

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-03-27 17:36:59 +01:00
parent b404ee50c3
commit b0b5d9e603
1 changed files with 26 additions and 0 deletions

View File

@ -4,6 +4,8 @@ title: Videos
toc_max: 3 toc_max: 3
--- ---
## iframe
To embed a video on a docs page, use an `<iframe>` element: To embed a video on a docs page, use an `<iframe>` element:
```html ```html
@ -14,3 +16,27 @@ To embed a video on a docs page, use an `<iframe>` element:
src="" src=""
></iframe> ></iframe>
``` ```
## asciinema
`asciinema` is a command line tool for recording terminal sessions. The
recordings can be embedded on the documentation site. These are similar to
`console` code blocks, but since they're playable and scrubbable videos, they
add another level of usefulness over static codeblocks in some cases. Text in
an `asciinema` "video" can also be copied, which makes them more useful.
Consider using an `asciinema` recording if:
- The input/output of the terminal commands are too long for a static example
(you could also consider truncating the output)
- The steps you want to show are easily demonstrated in a few commands
- Where the it's useful to see both inputs and outputs of commands
To create an `asciinema` recording and add it to docs:
1. [Install](https://docs.asciinema.org/getting-started/) the `asciinema` CLI
2. Run `asciinema auth` to configure your client and create an account
3. Start a new recording with `asciinema rec`
4. Run the commands for your demo and stop the recording with `<C-d>` or `exit`
5. Upload the recording to <asciinema.org>
6. Embed the player with a `<script>` tag using the **Share** button on <asciinema.org>