This is the WIP branch of the brand new vuejs.org. The content is under heavy updates and re-organization so please refrain from submitting PRs to this branch until we have removed this notice.

This site is built with VitePress and @vue/theme. Site content is written in Markdown format located in src.

Make sure to use pnpm as the package manager:

pnpm i
pnpm run dev

See the Vue Docs Writing Guide for our rules and recommendations on writing and maintaining documentation.

For now, local development requires cloning both this repo and vuejs/theme:

1. Clone repositories

git clone [email protected]:vuejs/docs.git
git clone [email protected]:vuejs/theme.git

2. Link theme into docs repo

# In ./theme
# Install dependencies
pnpm i
# Link workspace in ./theme
pnpm link --global

# in ./docs
pnpm link --global @vue/theme

3. Install deps and start VitePress server

# in ./docs
pnpm i
pnpm run dev