Update README.adoc
authorDaniel Mulholland <dan.mulholland@gmail.com>
Wed, 28 Aug 2019 20:18:39 +0000 (20:18 +0000)
committerDaniel Mulholland <dan.mulholland@gmail.com>
Wed, 28 Aug 2019 20:18:39 +0000 (20:18 +0000)
README.adoc

index fd03757..3d5c39e 100644 (file)
@@ -17,6 +17,7 @@
 :url-nodejs: https://nodejs.org
 :url-nvm: https://github.com/creationix/nvm
 :url-nvm-install: {url-nvm}#installation
+:url-sourcemap-information: https://developer.mozilla.org/en-US/docs/Tools/Debugger/How_to/Use_a_source_map
 
 image:{img-ci-status}[CI Status (GitLab CI), link={url-ci-pipelines}]
 
@@ -166,6 +167,17 @@ This works by monitoring the project for changes, running the `preview:build` ta
 
 Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.
 
+==== Source Maps
+
+In preview mode, {url-sourcemap-information}[source maps] are enabled. 
+This means that although Javascript and CSS files are combined into a single file (`site.js` or `site.css`) an additional `map` file is provided to allow a reference to the source.
+This is especially useful for debugging.
+
+This is mainly intended for preview and debugging not for production. 
+If you need this capability in production it can be achieved through an environment variable when bundling the UI:
+
+ $ SOURCEMAPS=true gulp build
+
 === Package for Use with Antora
 
 If you need to package the UI so you can use it to generate the documentation site locally, run the following command: