Repository files navigation

This is theVitePress theme for the official Vue documentation atvuejs.org.

Please note this theme is solely dedicated forvuejs.org and isn't meant to be used as a content-neutral theme. It doesnot follow semver and may contain hard-coded logic specific to the Vue documentation.

This repo can be developed on its own since it is a self-contained VitePress theme. Make sure to usepnpm as the package manager when installing deps. A demo app is available in/demo and can be run withpnpm dev:

pnpm installpnpm dev

To work on this theme in the context of thevuejs.org website requires cloning both repos and linking the theme into the docs repo:

1. Clone repositories:

   git clone git@github.com:vuejs/docs.gitgit clone git@github.com:vuejs/theme.git

2. Link theme into docs repo:

   # In ./themepnpm install# Make @vue/theme available for global linkingpnpm link --global# in ./docspnpm install# Link themepnpm link --global @vue/theme

3. Start VitePress server:

   # in ./docspnpm dev

Here is the list of available scripts that can be used during the development.

# Boot local dev server.$ pnpm dev# Build demo, then serve locally. This is for testing# production build in the local environment.$ pnpm serve# Run lint via Prettier.$ pnpm lint# Run type check via tsc.$ pnpmtype

MIT

Copyright (c) 2021-present Evan You