summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2021-07-04 23:48:57 -0600
committerDan Allen <dan.j.allen@gmail.com>2021-07-06 02:11:04 -0600
commitab373cced880e0ffd510e793463e33fb6733c3fa (patch)
treefadaf3044442729173fbd324763d309bc260cc30 /docs
parentdae5b3eb6b5b58e8ea1cbcebb82a874f058e2abd (diff)
add more prominent link to Ruby API for Asciidoctor; update links to AsciidoctorJ and Asciidoctor.js on API page [skip ci]
Diffstat (limited to 'docs')
-rw-r--r--docs/modules/ROOT/pages/index.adoc8
-rw-r--r--docs/modules/api/pages/index.adoc11
2 files changed, 8 insertions, 11 deletions
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
index 91b1f10c..33b6dc8b 100644
--- a/docs/modules/ROOT/pages/index.adoc
+++ b/docs/modules/ROOT/pages/index.adoc
@@ -1,5 +1,7 @@
= Asciidoctor Documentation
:navtitle: Introduction
+:url-cli: https://github.com/asciidoctor/asciidoctor/blob/master/man/asciidoctor.adoc
+:url-api: https://www.rubydoc.info/gems/asciidoctor
This is the documentation for the Ruby-based AsciiDoc processor, Asciidoctor.
Asciidoctor currently serves as the reference implementation for how to interpret the AsciiDoc language.
@@ -23,15 +25,15 @@ If you're using AsciiDoc.py, follow xref:migrate:asciidoc-py.adoc[] to learn how
== Basic usage
-Asciidoctor provides two primary interfaces for processing AsciiDoc documents:
+Asciidoctor provides two interfaces for processing AsciiDoc documents, a {url-cli}[CLI^] named `asciidoctor` and a {url-api}[Ruby API^] named `Asciidoctor`.
+The following table gives you an idea of how to use these interfaces.
|===
-|CLI |API
+^|CLI ^|API
a|
$ asciidoctor document.adoc
-
a|
[source,ruby]
----
diff --git a/docs/modules/api/pages/index.adoc b/docs/modules/api/pages/index.adoc
index 6510d907..692a466b 100644
--- a/docs/modules/api/pages/index.adoc
+++ b/docs/modules/api/pages/index.adoc
@@ -3,19 +3,14 @@
////
API introduction for Asciidoctor
included in the user-manual Quickstarts, Using the Ruby API
-doc-asciidoctorj is now url-asciidoctorj-docs but! that means I need to fix docref: link:/docs and doc-asciidoctorj: {docref}/asciidoctorj
////
-In addition to its CLI, Asciidoctor provides a Ruby API.
-The API is intended for integration with other Ruby software, such as Rails, GitHub, and GitLab, as well as other languages, such as Java (via AsciidoctorJ) and JavaScript (via Asciidoctor.js).
-
-Asciidoctor also has a Java API that mirrors the Ruby API.
-The Java API calls through to the Ruby API using an embedded JRuby runtime.
-See the xref:asciidoctorj::index.adoc[AsciidoctorJ documentation] for more information.
+In addition to its CLI, Asciidoctor provides a {url-api}[Ruby API^] named `Asciidoctor`.
+This API is intended for integration with other Ruby software, such as Rails, GitHub, and GitLab, as well as other languages, such as Java (via xref:asciidoctorj::index.adoc[AsciidoctorJ]) and JavaScript (via xref:asciidoctor.js::index.adoc[Asciidoctor.js]).
== Load and convert a document using the API
-To use Asciidoctor in your application, you first need to require the gem:
+To use the Asciidoctor API in your application, you first need to require the gem:
[source,ruby]
require 'asciidoctor'