From 20d113afcea6c2630bb0a07ed0c74cd822a1e224 Mon Sep 17 00:00:00 2001 From: Phillip Gates-Idem Date: Mon, 7 Mar 2016 19:50:41 -0500 Subject: [PATCH] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0f93b9492..f6933398d 100644 --- a/README.md +++ b/README.md @@ -221,11 +221,14 @@ For more details on Marko Widgets, please check out the [Marko Widgets Documenta ## nodemon -Marko compiles the templates into cached files. For example, it will create `index.marko.js` in the same folder as `index.marko` when the templates are loaded. This will cause a **reboot loop** in nodemon (and maybe similar watching tools) because when nodemon starts, the compiled file gets regenerated and trigger a restart loop for nodemon. +When `marko` compiles your server-side templates, a `.marko.js` file is created next to the original `.marko` file. +Subsequently, `nodemon` will see the new `.marko.js` file and trigger a restart of your app and this can +repeat indefinitely unless you configure `nodemon` to ignore `*.marko.js` files. +To avoid this, simply add `"ignore": ["*.marko.js"]` to the `nodemon.json` file at the root of your project. -To avoid this, simply add `"ignore": ["*.marko.js"]` into nodemon.json at the root project folder. - -As a better drop-in replacement with more features, you can install [browser-refresh](https://github.com/patrick-steele-idem/browser-refresh) instead. +As a better drop-in replacement with more features, you can install [browser-refresh](https://github.com/patrick-steele-idem/browser-refresh). +Be sure to add `*.marko.js` pattern to your `.gitignore` file and `browser-refresh` +will automatically ignore the compiled marko templates when they are written to disk. # Changelog