Get started

🚨 WARNING

Before starting to use it, you're supposed to know the following conventions:

• Vine was designed to only support Vue 3.0+ and Vite.
• Vine is designed to support only TypeScript, JavaScript-only users can't harness the complete range of functionalities.

Welcome to join us to exploring another style of writing Vue!

Install Vue Vine in your project:

pnpm i -D vue-vine

Vine provides a Vite plugin and a VSCode extension to offer feature support.

Besides, we also provide some other libraries that you might need during development or configuration, you can learn more details in the next section Ecosystem.

Install Vite plugin

Use the plugin in vite.config.ts:

import { VineVitePlugin } from 'vue-vine/vite'

export default defineConfig({
  plugins: [
    // ...Other plugins
    VineVitePlugin()
  ],
})

Install VSCode extension

Search "Vue Vine" in the marketplace and install it.

Use macro types

Vine provides a typescript declaration file to help you write macros with intellisense.

{
  "compilerOptions": {
    "types": ["vue-vine/macros"]
  }
}