plain-documentation: document handy watch script

karlvr · Dec 18, 2023 · 07aba97 · 07aba97
1 parent bc8647d
commit 07aba97
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/packages/plain-documentation/README.md b/packages/plain-documentation/README.md
@@ -7,6 +7,23 @@ An [OpenAPI Generator Plus](https://github.com/karlvr/openapi-generator-plus) te
 See the [OpenAPI Generator Plus](https://github.com/karlvr/openapi-generator-plus) documentation for how to use
 generator templates.
 
+For convenience when editing the API spec, or editing custom templates, you can setup a watch script and an automatically
+reloading web browser:
+
+```shell
+npm add -D live-server
+```
+
+Then add the following `npm` script, adjusting paths to your config file and output folder (`./dist` in this example):
+
+```json
+{
+ "scripts": {
+ "watch": "openapi-generator-plus -c config.yml --clean --watch & live-server --port=9123 ./dist & wait"
+ }
+}
+```
+
 ## Config file
 
 The available config file properties are: