summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2014-11-06 15:51:14 -0700
committerDan Allen <dan.j.allen@gmail.com>2014-11-06 15:51:14 -0700
commit78e667653c4d5b22a092475c1ec0db99d8fa2152 (patch)
tree715b517a7a0d608bec3a134f379c78be2f3b1247
parent17c366c57f92f40be6967f80624a1c38de245ec0 (diff)
parent0a313cbd37d81f2c59af61cc190353d5cebc7880 (diff)
Merge pull request #63 from leif81/patch-1
Add example for specifying theme file
-rw-r--r--README.adoc7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index c9c8f383..f5d4bdfb 100644
--- a/README.adoc
+++ b/README.adoc
@@ -228,6 +228,13 @@ The layout and styling of the PDF is driven by a YAML configuration file.
See the files [file]_default-theme.yml_ and [file]_asciidoctor-theme.yml_ found in the [file]_data/themes_ directory for examples.
+Specify the path to an alternate theme file with the `pdf-style` attribute. For example to use the built-in _asciidoctor_ theme:
+
+ $ ./bin/asciidoctor-pdf -a pdf-style=asciidoctor examples/example.adoc
+
+To refer to a theme at another location you can use the `pdf-stylesdir` attribute to specify the location of themes.
+If the `pdf-style` value does not end in `.yml`, then the file name is calculated as `{pdf-style}-theme.yml` located in the `pdf-stylesdir` directory (which defaults to the built-in `data/themes` directory).
+
== Optional Scripts
{project-name} also provides a shell script that invokes GhostScript (+gs+) to optimize and compress the generated PDF with minimal impact on quality.