diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-10-17 01:04:42 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-10-17 01:06:36 -0600 |
| commit | 236a2e683f3539424306566444520022339a64cf (patch) | |
| tree | 4572d721e31da978397748bd5d1ac1e94294f5e5 /docs/modules | |
| parent | 2a0a134dfae65a38ab0f1399118cff63564ae3f8 (diff) | |
add links from main converters page to page that lists available converters
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/convert/pages/available.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/convert/pages/index.adoc | 6 |
2 files changed, 6 insertions, 4 deletions
diff --git a/docs/modules/convert/pages/available.adoc b/docs/modules/convert/pages/available.adoc index c8bf91bc..227bb800 100644 --- a/docs/modules/convert/pages/available.adoc +++ b/docs/modules/convert/pages/available.adoc @@ -1,8 +1,9 @@ = Available Converters -This page lists the converters, and their associated backends, which are either built into Asciidoctor or distributed separately by the Asciidoctor project. +This page lists the converters, along with their associated backends and output formats, which are either built into Asciidoctor or distributed separately by the Asciidoctor project. There are additional "`unofficial`" converters for Asciidoctor which are not listed on this page. +[#built-in] == Built-in converters These built-in converters are bundled with Asciidoctor. @@ -23,6 +24,7 @@ xref:manpage-backend:index.adoc[Man page]:: The man page converter generates manual pages for software used on Unix and Unix-like operating systems. To use the man page converter, assign `manpage` to the `backend` option. +[#add-on] == Add-on converters You can use add-on converters, which plug into Asciidoctor by adding the appropriate library to the runtime path (e.g., `-r asciidoctor-pdf`). diff --git a/docs/modules/convert/pages/index.adoc b/docs/modules/convert/pages/index.adoc index 6aa9c811..dd0d2467 100644 --- a/docs/modules/convert/pages/index.adoc +++ b/docs/modules/convert/pages/index.adoc @@ -2,9 +2,9 @@ :page-aliases: ROOT:converters.adoc After Asciidoctor parses an AsciiDoc document, it uses a converter to generate the output format of your choice, such as HTML, DocBook, or PDF. -Asciidoctor includes a handful of built-in converters. -The Asciidoctor project provides additional converters that you can add on, which are distributed separately. -You also have the option of creating your own converter or using one published by a third party. +Asciidoctor includes a handful of xref:available.adoc#built-in[built-in converters]. +The Asciidoctor project provides xref:available.adoc#add-on[additional converters] that you can add on, which are distributed separately. +You also have the option to xref:custom.adoc[create your own converter] or to use one published by a third party. When working with converters, it's important to understand the distinction between a converter and a backend. This page explains that difference while also providing more background on how converters function. |