From 7afe8b67177a31f0088e2688eda6a13a8d6b69a1 Mon Sep 17 00:00:00 2001 From: Abel Salgado Romero Date: Fri, 4 Sep 2020 00:34:56 +0200 Subject: [PATCH] updates CHANGELOG --- CHANGELOG.adoc | 1 + README.adoc | 29 ++++++++++++++++------------- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index e54bb005..e65079b1 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -19,6 +19,7 @@ Improvements:: * Make `auto-refresh` (and `http` by inheritance) only convert modified and created sources (#474) * Make `auto-refresh` only copy modified and created resources + taking into consideration options (#478) * Make `auto-refresh` ignore docInfo files to avoid copying them into output (#480) + * Add official support for `http` mojo with life preview and refresh of html output (#483) Bug Fixes:: diff --git a/README.adoc b/README.adoc index 7c360f47..677867c8 100644 --- a/README.adoc +++ b/README.adoc @@ -453,7 +453,7 @@ This is specially useful in combination with a refresh browser extension, allowi Once started, this will keep the maven process running until you enter `exit` or `quit` command in the console. Or it is manually killed with _ctrl+c_. -[[http-goal-config-note]] +[[auto-refresh-goal-config-note]] [NOTE] ==== It is possible to run `auto-refresh` on your current project without changes provided the configuration is at top plugin level. @@ -508,21 +508,23 @@ If errors are found during initialization, plugin won't start. [[http-goal]] === HTML life preview (`http`) -The `http` goal allows starting and embedded http server to serve content from the generated output directory while updating it. +The `http` goal allows starting an embedded http server to access content from the generated output directory, while the plugin updates it. Modified sources will be updated similarly to how <> works. And at the same time, HTML contents will be automatically refreshed on the web browser without need for manual steps. Just open the file through the provided url that will appear in the console and write. -When introducing a URL, the file extension is not necessary for html files. + +Note than the file extension is not necessary for html files. +Bu default, the document _manual.html_ placed in the root path will be accessible as _pass:c[http://localhost:2000/manual]_. [NOTE] ==== -While this goal can be used to serve any kind of content (e.g. PDF). -The possibilities have not been explored and are not officially supported, but feedback is welcome. +While the `http` goal can be used to serve any kind of content (e.g. PDF). +The possibilities have not been explored and are not officially supported, but feedback is welcome if you want to share your experience and ideas. ==== [source,xml] -.Refresh configuration extract +.Http configuration extract ---- ... @@ -534,7 +536,7 @@ The possibilities have not been explored and are not officially supported, but f http - html + 8080 false @@ -546,19 +548,20 @@ The possibilities have not been explored and are not officially supported, but f ---- <1> The asciidoctor-maven-plugin does not run in any phase by default, so one must be specified. -<2> The Asciidoctor Maven plugin refresh goal. +<2> The Asciidoctor Maven plugin http goal. <3> Asciidoctor options. +Here we change the port to 8080. -This feature shares the following features and limitations with <> goal. +This feature shares the following features (and limitations) with <> goal. -* Once started, this will keep the maven process running until stoped (`exit`, `quit` commands or _ctrl+c_). +* Once started, this will keep the maven process running until explicitly stopped (`exit`, `quit` commands or _ctrl+c_). * Deleted or moved files will remain the output directory until clean. -* To take full advantage of configuration options, it must be explicitly configured in _pom.xml_ (see <>). -* `failIf` configurations will make the goal fail to start but won't stop the server once started. +* To take full advantage of configuration options, it must be explicitly configured in _pom.xml_ (see <>). +* `failIf` configurations will make the goal fail to start, but won't stop the server once started. ==== Configuration -The mojo accepts the same configurations as `process-asciidoc` and `refresh` mojos and adds: +The mojo accepts the same configurations as `process-asciidoc`, `refresh` mojos and adds: port:: server port. Defaults to `2000`.