@nolebase/ui-asciinema

Wrapper of asciinema-player for VitePress documentation sites.

[!CAUTION]

This package is in Alpha stage.

This package is still in the Alpha stage, and it is not recommended to use it in production. The API may change in the future, and there may be bugs in the current version. Please use it with caution.

[!IMPORTANT]

You will need to add the package to Vite's ssr.noExternal config ¹. Without it your site may not build.

1// vite.config.ts
2export default defineConfig({
3  vite: {
4    ssr: {
5      noExternal: [
6        "@nolebase/ui-asciinema",
7      ],
8    },
9  },
10})

Install

Npm

1npm i @nolebase/ui-asciinema -D

Yarn

1yarn add @nolebase/ui-asciinema -D

Pnpm

1pnpm add @nolebase/ui-asciinema -D

Documentation

Please refer to Asciinema Player package's documentation site for more information.

Footnotes

1. Vite's ssr.noExternal config docs: https://vitejs.dev/guide/ssr.html#ssr-externals. ↩