summaryrefslogtreecommitdiff
path: root/README.adoc
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 /README.adoc
parent1b45bc484502973620f0556482dba240d09bd963 (diff)
update instructions to convert basic example, retake screenshot, squoosh it, and store it in docs [no ci]
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.adoc b/README.adoc
index eb9a7e26..5f3f8f1b 100644
--- a/README.adoc
+++ b/README.adoc
@@ -149,7 +149,12 @@ If you see the version of {project-name} printed, you're ready to use {project-n
Let's grab an AsciiDoc document to distill and start putting {project-name} to use.
-If you don't already have an AsciiDoc document, you can use the <<examples/basic-example.adoc#,basic-example.adoc>> file found in the _examples_ directory of this project.
+If you don't already have an AsciiDoc document to work with, you can use the <<examples/basic-example.adoc#,basic-example.adoc>> file found in the _examples_ directory of this project.
+Copy it to the current directory as follows:
+
+ $ cp examples/basic-example.adoc .
+
+Let's take a look at the contents of that file.
ifeval::[{safe-mode-level} >= 20]
See <<examples/basic-example.adoc#,basic-example.adoc>>.
@@ -168,22 +173,23 @@ 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::examples/example-pdf-screenshot.png[Screenshot of PDF document,width=850,467,scaledwidth=100%]
+image::docs/modules/ROOT/images/basic-example-pdf-screenshot.png[Screenshot of PDF document,960,540,pdfwidth=100%]
For more information about how to use Asciidoctor PDF and PDF-specific AsciiDoc syntax, see the {url-project-docs}/[Asciidoctor PDF documentation].