Development

Requirements

(Lando) OR (Node 14+ and Yarn)

Yarn is optional

yarn is technically optional but is preferred and is assumed in the docs below. That said you can probably use npm as a drop in replacement for yarn below and end up in the same place.

# clone repo
git clone https://github.com/lando/vuepress-theme-default-plus.git &&
  \ cd vuepress-theme-default-plus

# start up app
lando start

# launch dev server
lando dev

# clone repo
git clone https://github.com/lando/vuepress-theme-default-plus.git &&
  \ cd vuepress-theme-default-plus

# install deps
yarn

# launch dev server
yarn dev

# launch dev server in debug mode
DEBUG="@lando/*" yarn dev

Testing

# lint the code
lando yarn test

# lint the code
yarn test

Building

Here are some helpful commands to build an artifact

# build the site
lando yarn build

# build the site
yarn build

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.