Skip to content

Commit

Permalink
related to #291 - added note regarding configuration of multiple reso…
Browse files Browse the repository at this point in the history
…urces (#292)

* related to #291 - added note regarding configuration of multiple resources for PDF

* Added @mojavelinux suggestions
  • Loading branch information
abelsromero authored Apr 3, 2017
1 parent 7499e67 commit 276cb8a
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,14 @@ sourceDocumentName:: an override to process a single source file; defaults to al
sourceDocumentExtensions:: (named `extensions` in v1.5.3 and below) a `List<String>` of non-standard file extensions to render. Currently ad, adoc, and asciidoc will be rendered by default
resources:: list of resource files to copy to the output directory (e.g., images, css). The configuration follows the same patterns as the `maven-resources-plugin`. If not set, all resources inside `sourceDirectory` are copied
+
[NOTE]
====
Converters that embed resources such as images into the output document need to be able to locate those resources at conversion time.
For example, when generating a PDF (or HTML with the `data-uri` attribute set), all images need to be aggregated under a common root (i.e., image catalog).
The `imagesdir` attribute should be overridden to point to that folder.
When converting to HTML, images must be copied to the output location so that the browser can resolve those images when the user views the page.
====
+
[source, xml]
----
<resources>
Expand Down

0 comments on commit 276cb8a

Please sign in to comment.