Project Command

This tutorial introduces VuePress project commands.

Common Commands

• vuepress dev <dir> starts a development server for local development of your VuePress site.
• vuepress build <dir> builds your VuePress site into static files for deployment.

Using Template

If you are using the VuePress Theme Hope template, you can find the following three commands in package.json:

{
  "scripts": {
    "docs:build": "vuepress build src",
    "docs:clean-dev": "vuepress dev src --clean-cache --clean-temp",
    "docs:dev": "vuepress dev src"
  }
}

This means you can use:

pnpm

• pnpm docs:dev starts the development server
• pnpm docs:build builds the project and outputs
• pnpm docs:clean-dev to clear cache and start development server

yarn

• yarn docs:dev starts the development server
• yarn docs:build builds the project and outputs
• yarn docs:clean-dev to clear cache and start development server

npm

• npm run docs:dev starts the development server
• npm run docs:build builds the project and outputs
• npm run docs:clean-dev to clear cache and start development server

Terminating Development Server

To terminate the development server, click on the terminal and press Ctrl + C twice.

Update Version

To upgrade your theme and VuePress version, execute the following command:

pnpm

pnpm dlx vp-update

yarn

yarn dlx vp-update

npm

npx vp-update