@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 [^1]. Without it your site may not build.

// vite.config.ts
export default defineConfig({
  vite: {
    ssr: {
      noExternal: [
        "@nolebase/ui-asciinema",
      ],
    },
  },
})

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

Install

Npm

npm i @nolebase/ui-asciinema -D

Yarn

yarn add @nolebase/ui-asciinema -D

Pnpm

pnpm add @nolebase/ui-asciinema -D

Documentation

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