diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2021-07-06 02:13:30 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2021-07-06 02:13:30 -0600 |
| commit | d7e2cb798fbc7a097c2835245b711293b6129d90 (patch) | |
| tree | f0bf283ba9ce5d45162779aa46b3a3442a28d65d | |
| parent | ab373cced880e0ffd510e793463e33fb6733c3fa (diff) | |
minor rewording on API page [skip ci]
| -rw-r--r-- | docs/modules/api/pages/index.adoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/modules/api/pages/index.adoc b/docs/modules/api/pages/index.adoc index 692a466b..22ac5700 100644 --- a/docs/modules/api/pages/index.adoc +++ b/docs/modules/api/pages/index.adoc @@ -5,7 +5,7 @@ API introduction for Asciidoctor included in the user-manual Quickstarts, Using the Ruby API //// -In addition to its CLI, Asciidoctor provides a {url-api}[Ruby API^] named `Asciidoctor`. +In addition to a 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 @@ -17,7 +17,7 @@ require 'asciidoctor' This one statement makes all of the {url-api}[public APIs in Asciidoctor^] available to your script or application. Now you can start processing AsciiDoc documents. -The main entry points in the Asciidoctor API are the static methods to load or convert AsciiDoc documents, which we'll cover on this page. +The main entry points in the Asciidoctor API are the static methods on the `Asciidoctor` module to load or convert AsciiDoc documents, which we'll cover on this page. To parse a file into an `Asciidoctor::Document` object: |