From 94c36093e72a91a31d3157e5a6968461a747ab20 Mon Sep 17 00:00:00 2001 From: Evan You Date: Fri, 8 Oct 2021 10:54:18 -0400 Subject: [PATCH] chore: update pnpm docs/ci --- .netlify.toml | 7 +++++++ README.md | 14 +++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) create mode 100644 .netlify.toml diff --git a/.netlify.toml b/.netlify.toml new file mode 100644 index 0000000..ac1f1df --- /dev/null +++ b/.netlify.toml @@ -0,0 +1,7 @@ +[build.environment] + NODE_VERSION = "16" + NPM_FLAGS = "--version" # prevent Netlify npm install + +[build] + publish = "docs/.vitepress/dist" + command = "npx pnpm i --store=node_modules/.pnpm-store && npm run demo-build" diff --git a/README.md b/README.md index 7e33bbb..d950902 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ WIP VitePress theme for the new version of Vue documentation. **Currently under ## Development Setup -This repo can be developed on its own since it is a self-contained VitePress theme. A demo app is available in `/demo` and can be run with `yarn dev`. Just install NPM packages and boot the server with `yarn dev`. +This repo can be developed on its own since it is a self-contained VitePress theme. Make sure to use [pnpm](https://pnpm.io/) as the package manager when installing deps. A demo app is available in `/demo` and can be run with `npm run dev`: ```bash -$ yarn install -$ yarn dev +$ pnpm install +$ npm run dev ``` To work on this theme in the context of the `vuejs.org` website, see [vuejs/docs#next](https://github.com/vuejs/docs/tree/next) for instructions. @@ -19,17 +19,17 @@ Here is the list of available scripts that can be used during the development. ```bash # Boot local dev server. -$ yarn dev +$ npm run dev # Build demo, then serve locally. This is for testing # production build in the local environment. -$ yarn serve +$ npm run serve # Run lint via Prettier. -$ yarn lint +$ npm run lint # Run type check via tsc. -$ yarn type +$ npm run type ``` ## License