diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-09-22 23:26:20 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-09-23 02:26:32 -0600 |
| commit | 6efc2e9b247eec8f832e2fbf05e5499386407b62 (patch) | |
| tree | 7a459bec8eea8510a7707f70a26e84579f18c6b8 /docs/modules | |
| parent | 07c9a96e24ea5257e71d2cc8664d4ecd0f6af9f6 (diff) | |
clarify description of Asciidoctor in docs
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/ROOT/pages/index.adoc | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index f9409c57..55344436 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -9,10 +9,12 @@ If you're looking for the documentation for the AsciiDoc language, see the xref: == What is Asciidoctor? -Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc into a document model and converting it to output formats such as [.nowrap]#HTML 5#, [.nowrap]#DocBook 5#, manual pages, PDF, and [.nowrap]#EPUB 3#. -This Ruby library is often referred to as Asciidoctor core. -That's because Asciidoctor is also the name of the family of projects that contribute extensions and tools for processing AsciiDoc. -When we say Asciidoctor in this section of the documentation, we're specifically referring to Asciidoctor core. +Asciidoctor is a fast, open source, text processor for parsing AsciiDoc into a document model and converting it to output formats such as [.nowrap]#HTML 5#, [.nowrap]#DocBook 5#, man(ual) pages, PDF, and [.nowrap]#EPUB 3#. +Asciidoctor is written in the Ruby programming language. + +//This Ruby library (or gem) is often referred to as the core Asciidoctor processor, or _Asciidoctor core_ for short. +When we refer to Asciidoctor in this area of the documentation, we're specifically referring to the core Asciidoctor processor, abbreviated as Asciidoctor core. +We add this qualifier because Asciidoctor is also the name of the family of projects that provide runtimes, extensions, and tools for processing AsciiDoc. To simplify installation, Asciidoctor is packaged and distributed to RubyGems.org as a {url-rubygems}/asciidoctor[RubyGem named asciidoctor^]. The asciidoctor gem can be installed on all major operating systems using Ruby packaging tools (gem or bundle). |
