diff --git a/README.md b/README.md index 8b13789..05ad4ca 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ +### Development + +#### Install +- **Node.js** >= 23 + +1. Install [VitePress](https://vitepress.dev/) using `npm add -D vitepress` +2. Install [Vue](https://vuejs.org/) using `npm add -D vue` + +#### Run +1. First build the static pages using VitePress by running `npm run docs:build` +2. You can then can preview the site using `npm run docs:preview` + +**Note:** Changes to your documentation files will only be reflected after rebuilding the static pages