Merge pull request #135 from remcohaszing/contributing-docs

Enhance contribution instructions

CONTRIBUTING.md

@@ -1,5 +1,15 @@
 # Contributing
 
+## Prerequisites
+
+The following are required to start working on this project:
+
+- [Git](https://git-scm.com)
+- [NodeJS](https://nodejs.org) 16 or higher
+- [npm](https://github.com/npm/cli) 8.1.2 or higher
+
+## Getting started
+
 To get started with contributing, clone the repository and install its dependencies.
 
 ```sh
@@ -8,16 +18,19 @@ cd monaco-yaml
 npm ci
 ```
 
+## Building
+
 To build the repository, run:
 
 ```sh
-npm prepack
+npm run prepack
 ```
 
+## Running
+
 To test it, run one of the
 [examples](https://github.com/remcohaszing/monaco-yaml/tree/main/examples).
 
 ```sh
-cd examples/webpack-worker-loader
-npm start
+npm --workspace demo start
 ```

examples/demo/README.md

@@ -2,10 +2,30 @@
 
 This demo is deployed to [monaco-yaml.js.org](https://monaco-yaml.js.org). It shows how
 `monaco-editor` and `monaco-yaml` can be used with
-[Webpack 5](https://webpack.js.org/concepts/entry-points). To start it, simply run:
+[Webpack 5](https://webpack.js.org/concepts/entry-points).
+
+## Prerequisites
+
+- [NodeJS](https://nodejs.org) 16 or higher
+- [npm](https://github.com/npm/cli) 8.1.2 or higher
+
+## Setup
+
+To run the project locally, clone the repository and set it up:
 
 ```sh
-npm start
+git clone https://github.com/remcohaszing/monaco-yaml
+cd monaco-yaml
+npm ci
+npm run prepack
+```
+
+## Running
+
+To start it, simply run:
+
+```sh
+npm --workspace demo start
 ```
 
 The demo will open in your browser.

examples/minimal-vite/README.md

@@ -1,3 +0,0 @@
-# Minimal Vite Example
-
-This minimal example shows how `monaco-yaml` can be used with [Vite](https://vitejs.dev).

examples/monaco-editor-webpack-plugin/README.md

@@ -7,8 +7,28 @@ Example is based on
 [link](https://github.com/microsoft/monaco-editor-samples/tree/main/browser-esm-webpack-monaco-plugin).
 To start it, simply run:
 
+## Prerequisites
+
+- [NodeJS](https://nodejs.org) 16 or higher
+- [npm](https://github.com/npm/cli) 8.1.2 or higher
+
+## Setup
+
+To run the project locally, clone the repository and set it up:
+
 ```sh
-npm start
+git clone https://github.com/remcohaszing/monaco-yaml
+cd monaco-yaml
+npm ci
+npm run prepack
+```
+
+## Running
+
+To start it, simply run:
+
+```sh
+npm --workspace monaco-editor-webpack-plugin-example start
 ```
 
 The demo will open in your browser.

examples/vite-example/README.md

@@ -0,0 +1,29 @@
+# Vite Example
+
+This minimal example shows how `monaco-yaml` can be used with [Vite](https://vitejs.dev).
+
+## Prerequisites
+
+- [NodeJS](https://nodejs.org) 16 or higher
+- [npm](https://github.com/npm/cli) 8.1.2 or higher
+
+## Setup
+
+To run the project locally, clone the repository and set it up:
+
+```sh
+git clone https://github.com/remcohaszing/monaco-yaml
+cd monaco-yaml
+npm ci
+npm run prepack
+```
+
+## Running
+
+To start it, simply run:
+
+```sh
+npm --workspace vite-example start
+```
+
+The demo will be available on http://localhost:3000.

examples/vite-example/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "minimal-vite",
+  "name": "vite-example",
   "version": "1.0.0",
   "private": true,
   "scripts": {