summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-05-17 15:25:34 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-05-17 15:54:59 -0600
commit82e8998433a86c0bfade26f568e6429b9ef7dc46 (patch)
treec0b72627d60e1e4084949842b4f533bb671567d0 /docs/modules
parent1b45bc484502973620f0556482dba240d09bd963 (diff)
update instructions to convert basic example, retake screenshot, squoosh it, and store it in docs [no ci]
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/ROOT/images/basic-example-pdf-screenshot.pngbin0 -> 94341 bytes
l---------docs/modules/ROOT/images/example-pdf-screenshot.png1
-rw-r--r--docs/modules/ROOT/pages/convert-to-pdf.adoc16
3 files changed, 10 insertions, 7 deletions
diff --git a/docs/modules/ROOT/images/basic-example-pdf-screenshot.png b/docs/modules/ROOT/images/basic-example-pdf-screenshot.png
new file mode 100644
index 00000000..5b471d03
--- /dev/null
+++ b/docs/modules/ROOT/images/basic-example-pdf-screenshot.png
Binary files differ
diff --git a/docs/modules/ROOT/images/example-pdf-screenshot.png b/docs/modules/ROOT/images/example-pdf-screenshot.png
deleted file mode 120000
index 91b828c6..00000000
--- a/docs/modules/ROOT/images/example-pdf-screenshot.png
+++ /dev/null
@@ -1 +0,0 @@
-../../../../examples/example-pdf-screenshot.png \ No newline at end of file
diff --git a/docs/modules/ROOT/pages/convert-to-pdf.adoc b/docs/modules/ROOT/pages/convert-to-pdf.adoc
index 519d6ce1..0c0acc20 100644
--- a/docs/modules/ROOT/pages/convert-to-pdf.adoc
+++ b/docs/modules/ROOT/pages/convert-to-pdf.adoc
@@ -10,6 +10,9 @@ If you see the version of Asciidoctor PDF printed, you're ready to use Asciidoct
Let's grab an AsciiDoc document to distill and start putting Asciidoctor PDF to use.
If you don't already have an AsciiDoc document, you can download and use the xref:attachment$basic-example.adoc[Basic Example AsciiDoc file].
+Store the file in the current directory.
+
+Let's take a look at the contents of that file.
.basic-example.adoc
[,asciidoc]
@@ -23,19 +26,20 @@ It's time to convert the AsciiDoc document directly to PDF.
IMPORTANT: You'll need the `rouge` gem installed to run this example since it uses the `source-highlighter` attribute with the value of `rouge`.
-Converting to PDF is as simple as running the `asciidoctor-pdf` script using Ruby and passing our AsciiDoc document as the first argument.
+Converting to PDF is as straightforward as running the `asciidoctor-pdf` script using Ruby and passing the AsciiDoc document as the first argument:
$ asciidoctor-pdf basic-example.adoc
-This command is just a shorthand way of running:
+This command is a shorter way of running `asciidoctor` with the PDF converter and backend enabled:
$ asciidoctor -r asciidoctor-pdf -b pdf basic-example.adoc
-The `asciidoctor-pdf` command just saves you from having to remember all those flags.
-That's why we created it.
+The `asciidoctor-pdf` command saves you from having to remember these low-level options.
+That's why we provide it.
-When the script completes, you should see the file [.path]_basic-example.pdf_ in the same directory.
+When the script completes, you should see the file [.path]_basic-example.pdf_ in the current directory.
+Asciidoctor creates the output file in the same directory as the input file by default.
Open the [.path]_basic-example.pdf_ file with a PDF viewer to see the result.
.Example PDF document rendered in a PDF viewer
-image::example-pdf-screenshot.png[Screenshot of PDF document,850,pdfwidth=100%]
+image::basic-example-pdf-screenshot.png[Screenshot of PDF document,960,540,pdfwidth=100%]