Development

Requirements

• Node.js version 18 or higher.
• Terminal for accessing VitePress via its command line interface (CLI).
• Text Editor with Markdown syntax support.
  • VSCode is recommended, along with the official Vue extension.

VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with:

Up and Running

# clone repo and install deps
git clone https://github.com/lando/vitepress-theme-default-plus.git &&
  \ cd vitepress-theme-default-plus &&
  \ npm install

# start dev server
npm run dev

Testing

npm run test

Building

# build the static site
npm run build

# preview the static site
npm run preview

Releasing

An actual release to npm can be done by creating a release on GitHub. Pre-releases will deploy to @edge tag.

This will also trigger our prepare release and auto-deploy actions.