Getting Started
Installation
Option #1 (Preferred): Install Node with brew.
brew install n
sudo n 12
Option #2: Install Node using the official resources installer.
Install project dependencies.
npm install
Developing
Runs the local build server with hot module reloading and eslint watcher.
npm run dev
Linting
Manually lint the files for any breaking changes.
npm run lint
Testing
Run all tests.
npm run test
or run the full tests that Husky will test for.
npm run test:full
Building
Build out the entire site as a static project.
npm run build
Purging
Clean out all Node packages.
npm run purge
Caveats
Occasionally we may want to upgrade all packages to keep the project up to date, but since Vuepress is built on Vue 2 there are some discrepencies when trying to update everything. The following should not be updated:
- vuex
- sass-loader
Some dependencies need dev dependencies in order to work since their last update, this includes:
- webpack