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

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
yarn
# Link workspace in ./theme
yarn link

# in ./docs
yarn link @vue/theme

3. Install deps and start VitePress server

# in ./docs
yarn
yarn serve

The site is automatically deployed when commits land in master, via Netlify.