This is the VitePress theme for the official Vue documentation at vuejs.org.
Please note this theme is solely dedicated for vuejs.org and isn't meant to be used as a content-neutral theme. It does not 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 use pnpm as the package manager when installing deps. A demo app is available in /demo and can be run with npm run dev:
$ pnpm install
$ npm run devTo work on this theme in the context of the vuejs.org website requires cloning both repos and linking the theme into the docs repo:
-
Clone repositories:
git clone git@github.com:vuejs/docs.git git clone git@github.com:vuejs/theme.git
-
Link theme into docs repo:
# In ./theme pnpm install # Make @vue/theme available for global linking pnpm link --global # in ./docs pnpm install # Link theme pnpm link --global @vue/theme
-
Start VitePress server:
# in ./docs pnpm run dev
Here is the list of available scripts that can be used during the development.
# Boot local dev server.
$ npm run dev
# Build demo, then serve locally. This is for testing
# production build in the local environment.
$ npm run serve
# Run lint via Prettier.
$ npm run lint
# Run type check via tsc.
$ npm run typeCopyright (c) 2021-present Evan You