Skip to content
On this page

VuePress Integration

Vue-Termynal was created to make documentation sites prettier. Fortunately VuePress can render Vue.js components out of the box, so using this library with it is fairly trivial.

VuePress-next

Create a file in your docs/.vuepress folder called client.{js|ts} with the following content:

js
import { defineClientConfig } from "@vuepress/client"
import VueTermynalPlugin from "@lehoczky/vue-termynal"

export default defineClientConfig({
  enhance({ app }) {
    app.use(VueTermynalPlugin)
  },
})

After this, you can use the components like in any other vue app.

Read more about defineClientConfig in the offical docs.