From 2da19ac24b3bf4540c58db73c47ca39bc97bdadd Mon Sep 17 00:00:00 2001 From: Daniel Mulholland Date: Wed, 28 Aug 2019 20:18:39 +0000 Subject: [PATCH] Update README.adoc --- README.adoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.adoc b/README.adoc index fd03757..3d5c39e 100644 --- a/README.adoc +++ b/README.adoc @@ -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: -- 2.11.0