diff options
| author | Sarah White <graphitefriction@gmail.com> | 2020-12-03 17:30:34 -0700 |
|---|---|---|
| committer | Sarah White <graphitefriction@gmail.com> | 2020-12-08 14:32:53 -0700 |
| commit | 062ddfe40c7b90205b74d1313969cd3287be99fe (patch) | |
| tree | 86ac30555a62461bab3a5a98f5d6adef6496d973 /docs | |
| parent | a90f36363994f51fd5bb142942608e9dd7b8dd25 (diff) | |
content clarifications, syntax fixes, and added xrefs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/ROOT/nav-top.adoc | 3 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/converters.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/features.adoc | 24 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/index.adoc | 20 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/localization-support.adoc | 39 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/whats-new.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/api/pages/index.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/docbook-backend/pages/index.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/get-started/pages/index.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/html-backend/pages/index.adoc | 7 | ||||
| -rw-r--r-- | docs/modules/install/pages/index.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/install/pages/linux-packaging.adoc | 12 | ||||
| -rw-r--r-- | docs/modules/install/pages/supported-platforms.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/install/partials/success.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/manpage-backend/pages/index.adoc | 4 | ||||
| -rw-r--r-- | docs/modules/stem/pages/index.adoc | 2 | ||||
| -rw-r--r-- | docs/modules/syntax-highlighting/pages/index.adoc | 8 |
17 files changed, 72 insertions, 67 deletions
diff --git a/docs/modules/ROOT/nav-top.adoc b/docs/modules/ROOT/nav-top.adoc index 98431ff5..63ac8da8 100644 --- a/docs/modules/ROOT/nav-top.adoc +++ b/docs/modules/ROOT/nav-top.adoc @@ -1,2 +1,5 @@ +[] * xref:features.adoc[] + +[] * xref:whats-new.adoc[] diff --git a/docs/modules/ROOT/pages/converters.adoc b/docs/modules/ROOT/pages/converters.adoc index 9340f9f0..31c54489 100644 --- a/docs/modules/ROOT/pages/converters.adoc +++ b/docs/modules/ROOT/pages/converters.adoc @@ -18,7 +18,7 @@ Each converter is mapped to a name that you specify using the `-b` (`--backend`) These built-in converters are bundled with Asciidoctor. -HTML:: +xref:html-backend:index.adoc[HTML]:: The HTML 5 converter (`html` or `html5`) generates HTML 5 styled with CSS3. This is the converter Asciidoctor uses by default. diff --git a/docs/modules/ROOT/pages/features.adoc b/docs/modules/ROOT/pages/features.adoc index 29d45840..e091af55 100644 --- a/docs/modules/ROOT/pages/features.adoc +++ b/docs/modules/ROOT/pages/features.adoc @@ -6,25 +6,25 @@ This page covers the features of Asciidoctor that make it a great choice for pro Asciidoctor is written in Ruby, which means it must be run on a Ruby language runtime (including JRuby). But that's its only requirement. -Asciidoctor is packaged and distributed as a RubyGem (aka gem) to the main package repository at https://rubygems.org[RubyGems.org^]. -What that means is that the gem can be installed on *any operating system* Ruby supports using Ruby's package management tools (gem or bundle). +Asciidoctor is packaged and distributed as a {url-rubygem}/asciidoctor[RubyGem to the package repository at RubyGems.org^]. +The gem can be installed on *any operating system* Ruby supports using Ruby's package management tools (gem or bundle). Asciidoctor itself has no dependencies. But what if you aren't familiar with Ruby or, for whatever reason, prefer not to install it? No problem! Thanks to {url-asciidoctorj}[AsciidoctorJ^] and xref:asciidoctor.js::index.adoc[Asciidoctor.js], you can run the same exact version of Asciidoctor on a Java Virtual Machine (JVM) or JavaScript runtime, respectively. -That means you _don't_ need a Ruby runtime installed on your machine after all. -(AsciidoctorJ uses JRuby internally, whereas Asciidoctor.js relies on a Ruby-like runtime written in JavaScript). +That means you don't need a Ruby runtime installed on your machine after all. +AsciidoctorJ uses JRuby internally, whereas Asciidoctor.js relies on a Ruby-like runtime written in JavaScript. Whether your working in Ruby, Java, or JavaScript, Asciidoctor is readily available for you to start using. -(Only when you get into extended converters and extensions do you need to install dependencies). +Only when you get into extended converters and extensions do you need to install dependencies. == Quick wins -Asciidoctor provides a really nice out-of-the-box xref:html-backend:index.adoc[HTML experience], complete with a default stylesheet and built-in integrations like Font Awesome (for icons), Highlight.js (for source highlighting), and MathJax (for STEM processing). +Asciidoctor provides a nice out-of-the-box xref:html-backend:index.adoc[HTML experience], complete with a default stylesheet and built-in integrations like Font Awesome (for icons), Highlight.js (for source highlighting), and MathJax (for STEM processing). When you're just getting into using AsciiDoc for writing, Asciidoctor's HTML output should be sufficient for all of your publishing needs. -The following before and after picture should give you an idea of what to expect: +The following before and after picture gives you an idea of what to expect: image::source-vs-output.png[AsciiDoc source vs HTML output] @@ -37,8 +37,8 @@ So there is plenty of room to grow. Asciidoctor provides converters for three output formats by default: xref:html-backend:index.adoc[HTML 5], xref:docbook-backend:index.adoc[DocBook 5], and xref:manpage-backend:index.adoc[manpage] (manual page). These converters are designed to cover a majority of users`' needs for basic preview and publishing. -The *HTML* converter gives you a result you can publish the web straight away without any tweaking. -The *DocBook* converter allows you to either leverage an existing publishing toolchain or migrate the content to a different authoring format (without the tool needing to know how to parse AsciiDoc). +The *HTML* converter provides a result you can publish the web straight away without any tweaking. +The *DocBook* converter allows you to leverage an existing publishing toolchain or migrate the content to a different authoring format (without the tool needing to know how to parse AsciiDoc). The *manpage* converter drastically lowers the barrier to making system help files. But it doesn't end there. @@ -127,15 +127,15 @@ In addition to its performance, these security levels make Asciidoctor well-suit == Access to an ecosystem of extensions and tools Installating Asciidoctor is just the beginning of your publishing experience. -Asciidoctor gives you access to a {url-org}[healthy ecosystem of extensions and tools], ranging from converters, to extended syntax, to build plugins, to integrated writing and preview environments. +Asciidoctor gives you access to a {url-org}[healthy ecosystem of extensions and tools^], ranging from converters, to extended syntax, to build plugins, to integrated writing and preview environments. -One popular extension is {url-org}/asciidoctor-diagram[Asciidoctor Diagram]. +One popular extension is {url-org}/asciidoctor-diagram[Asciidoctor Diagram^]. When loaded, Asciidoctor Diagram allows you to make diagrams from plain text (much like AsciiDoc does for writing). Asciidoctor Diagram does this by extending the syntax of AsciiDoc to recognize specially marked literal blocks. It takes the text inside those blocks, passes it through one of the diagramming tools it integrates with, and reinserts the image back into the document as it is being processed. The result is that the diagram source in the AsciiDoc document becomes an image in the generated output. -One popular tool is the {url-org}/asciidoctor-browser-extension[browser extension]. +Another popular tool is the {url-org}/asciidoctor-browser-extension[browser extension^]. When this extension is installed, you can browse to an AsciiDoc file on your harddisk or on the web and the browser will show you the converted HTML *instead of* the AsciiDoc source. That means you can get the out-of-the-box HTML experience that Asciidoctor provides without even having to run a command or script. The extension running in the browser does everything for you. diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index bccb23e5..0644b608 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,38 +1,32 @@ = Asciidoctor Documentation :navtitle: Introduction -[caption=Migration in Progress] -CAUTION: This documentation is in migration. -If you're looking for the current Asciidoctor documentation, visit https://asciidoctor.org/docs. - -This section of the website contains the documentation for {url-project}[Asciidoctor^], a Ruby-based AsciiDoc processor. +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. -If you're looking for the documentation for the AsciiDoc language itself, refer to the xref:asciidoc::index.adoc[AsciiDoc section] of this website. -//You can also find the documentation for AsciidoctorJ, Asciidoctor.js, and various extensions and integrations in other areas of this website. +If you're looking for the documentation for the AsciiDoc language, see the xref:asciidoc::index.adoc[AsciiDoc section] of this website. == What is Asciidoctor? -Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc into a document model and converting to output formats such as [.nowrap]#HTML 5#, [.nowrap]#DocBook 5#, manpage, PDF, and [.nowrap]#EPUB 3#. +Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc into a document model and converting 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 Asciidoctor. When we say Asciidoctor in this section of the documentation, we're specifically referring to Asciidoctor core. -To simplify installation, Asciidoctor is packaged and distributed as a RubyGem (aka gem) named https://rubygems.org/gem/asciidoctor[asciidoctor] to {url-rubygem}[RubyGems.org^]. +To simplify installation, Asciidoctor is packaged and distributed to RubyGems.org as a {url-rubygem}/asciidoctor[RubyGem named asciidoctor^]. The asciidoctor gem can be installed on all major operating systems using Ruby packaging tools (gem or bundle). Asciidoctor is also distributed as a package for numerous Linux distributions as well as macOS. Asciidoctor is open source software that is available under the terms of the MIT license and {url-org}[hosted on GitHub^]. Asciidoctor is the successor to AsciiDoc Python (AsciiDoc.py). -If you're still using AsciiDoc.py, follow xref:migrate:asciidoc-python.adoc[] to learn how to upgrade to Asciidoctor. +If you're using AsciiDoc.py, follow xref:migrate:asciidoc-python.adoc[] to learn how to upgrade to Asciidoctor. == Basic usage Asciidoctor provides two primary interfaces for processing AsciiDoc documents: -[cols=2*] |=== -| CLI | API +|CLI |API a| $ asciidoctor document.adoc @@ -81,7 +75,7 @@ You can find the documentation for these projects elsewhere on this site or in t == Beyond Ruby -Although Asciidoctor is written in Ruby, it does not mean you are stuck using Ruby. +Although Asciidoctor is written in Ruby, it does not mean you have to use Ruby. You can also run Asciidoctor using a JVM or JavaScript. === Java / JVM diff --git a/docs/modules/ROOT/pages/localization-support.adoc b/docs/modules/ROOT/pages/localization-support.adoc index 2d39c52a..054dd96a 100644 --- a/docs/modules/ROOT/pages/localization-support.adoc +++ b/docs/modules/ROOT/pages/localization-support.adoc @@ -1,9 +1,8 @@ = Localization Support :url-docbook-i8n: http://www.sagehill.net/docbookxsl/Localizations.html :url-lang-attributes: {url-org}/asciidoctor/blob/master/data/locale/attributes.adoc -// um anchor: language-support -However, Asciidoctor is not restricted to working with English-only content. +Asciidoctor is not restricted to working with English-only content. Asciidoctor can process the full range of the UTF-8 character set. That means you can write your document in any language, save the file with UTF-8 encoding, and expect Asciidoctor to convert the text properly. @@ -41,77 +40,77 @@ If you're not using the DocBook toolchain for publishing, you must translate eac One way is to set the following attributes in the document header or by passing the attributes via the API or CLI: .Attributes that control built-in labels -[%autowidth,cols="m,,"] +[cols="~,~,30%"] |=== |Attribute |Default English Value |Notes -|appendix-caption +|`appendix-caption` |Appendix | -|caution-caption +|`caution-caption` |Caution | -|chapter-label +|`chapter-label` |Chapter |Applies only when `doctype` is `book`. PDF converter only. -|example-caption +|`example-caption` |Example | -|figure-caption +|`figure-caption` |Figure | -|important-caption +|`important-caption` |Important | -|last-update-label +|`last-update-label` |Last updated | -|listing-caption +|`listing-caption` |_not set_ |By default, listing blocks do not have captions. Specify `listing-caption` to turn on listing block captions. -|manname-title +|`manname-title` |NAME |Applies only when `doctype` is `manpage`. -|note-caption +|`note-caption` |Note | -|preface-title +|`preface-title` |_not set_ |Applies only when `doctype` is `book`. -|table-caption +|`table-caption` |Table | -|tip-caption +|`tip-caption` |Tip | -|toc-title +|`toc-title` |Table of Contents | -|untitled-label +|`untitled-label` |Untitled | -|version-label +|`version-label` |Version | -|warning-caption +|`warning-caption` |Warning | |=== diff --git a/docs/modules/ROOT/pages/whats-new.adoc b/docs/modules/ROOT/pages/whats-new.adoc index 8055e9bf..7c7b2305 100644 --- a/docs/modules/ROOT/pages/whats-new.adoc +++ b/docs/modules/ROOT/pages/whats-new.adoc @@ -1,11 +1,11 @@ //= What's New (Asciidoctor {page-component-version}) -= What's New ({page-component-version}) += What's New in {page-component-version} :doctype: book :page-toclevels: 0 :url-releases-asciidoctor: {url-org}/asciidoctor/releases :url-milestone: {url-org}/asciidoctor/milestone/33?closed=1: -This page covers the changes introduced in each of the patch releases in the Asciidoctor {page-component-version} release line ({page-component-version}.0, {page-component-version}.1, ...). +This page lists the changes made in each of the patch releases in the Asciidoctor {page-component-version} release line. The releases are ordered from newest to oldest. _**Cumulative issues resolved:** {url-milestone}[2.0.x^]_ diff --git a/docs/modules/api/pages/index.adoc b/docs/modules/api/pages/index.adoc index 5c909faa..6a53b4b1 100644 --- a/docs/modules/api/pages/index.adoc +++ b/docs/modules/api/pages/index.adoc @@ -20,7 +20,7 @@ To use Asciidoctor in your application, you first need to require the gem: [source,ruby] require 'asciidoctor' -This one statement makes all of the {url-api}[public APIs in Asciidoctor] available to your script or application. +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. diff --git a/docs/modules/docbook-backend/pages/index.adoc b/docs/modules/docbook-backend/pages/index.adoc index c6ef9962..b6e5c184 100644 --- a/docs/modules/docbook-backend/pages/index.adoc +++ b/docs/modules/docbook-backend/pages/index.adoc @@ -8,6 +8,10 @@ Asciidoctor can produce DocBook 5.0 XML output. There's a corresponding DocBook element for each AsciiDoc element. +`docbook`:: +The DocBook 5.0 converter generates DocBook 5.0 XML. +To use the DocBook converter, assign `docbook` or `docbook5` to the `backend` option. + == Generate DocBook with the docbook converter To convert the [.path]_mysample.adoc_ document to DocBook 5.0 format, call the processor with the backend flag set to `docbook`. diff --git a/docs/modules/get-started/pages/index.adoc b/docs/modules/get-started/pages/index.adoc index 89b0bee1..9daf9562 100644 --- a/docs/modules/get-started/pages/index.adoc +++ b/docs/modules/get-started/pages/index.adoc @@ -47,4 +47,4 @@ The converted document should look like the example below. The document's text, titles, and link is styled by the default Asciidoctor stylesheet, which is embedded in the HTML output. As a result, you could save [.path]_my-sample.html_ to any computer and it will look the same. -TIP: Most of the examples in the general documentation use the CLI, but there are usually corresponding API examples under Working with the API. +TIP: Most of the examples in the general documentation use the CLI, but there are usually corresponding API examples under xref:api:index.adoc[]. diff --git a/docs/modules/html-backend/pages/index.adoc b/docs/modules/html-backend/pages/index.adoc index be3c9ec3..2e556ed4 100644 --- a/docs/modules/html-backend/pages/index.adoc +++ b/docs/modules/html-backend/pages/index.adoc @@ -5,7 +5,7 @@ Asciidoctor's default output format is HTML. -`html5`:: HTML 5 markup styled with CSS3. +`html`:: The HTML 5 converter (`html` or `html5`) generates HTML 5 styled with CSS3. == Generate HTML using the html5 converter @@ -53,9 +53,10 @@ As a result, you could save [.path]_my-sample.html_ to any computer and it will [#xhtml] == Generate XHTML -To convert AsciiDoc to XHTML, set the backend to `xhtml5`. +`xhtml`:: The XHTML variant of the HTML 5 converter. +To use the XHTML converter, assign `xhtml` or `xhtml5` to the `backend` option. -.Produce XHTML using the built-in HTML converter +.Produce XHTML using the xhtml5 backend option [source,console] ---- asciidoctor -b xhtml5 document.adoc diff --git a/docs/modules/install/pages/index.adoc b/docs/modules/install/pages/index.adoc index 67ecc0b0..1cfcaa2c 100644 --- a/docs/modules/install/pages/index.adoc +++ b/docs/modules/install/pages/index.adoc @@ -1,6 +1,6 @@ = Install and Update -To simplify installation, Asciidoctor is packaged and distributed as a RubyGem (aka gem) to {url-rubygem}/asciidoctor[RubyGems.org^]. +To simplify installation, Asciidoctor is packaged and distributed as a {url-rubygem}/asciidoctor[RubyGem to the package repository at RubyGems.org^]. It's also distributed as a package for popular Linux distributions and macOS. In addition to running on Ruby, Asciidoctor can be executed on a JVM using {url-asciidoctorj}[AsciidoctorJ^] or in any JavaScript environment (including the browser) using xref:asciidoctor.js::index.adoc[Asciidoctor.js]. diff --git a/docs/modules/install/pages/linux-packaging.adoc b/docs/modules/install/pages/linux-packaging.adoc index 940fecf3..1033a622 100644 --- a/docs/modules/install/pages/linux-packaging.adoc +++ b/docs/modules/install/pages/linux-packaging.adoc @@ -13,12 +13,12 @@ The benefit of using your operating system's package manager to install the gem The version of Asciidoctor installed by the package manager may not match the latest release of Asciidoctor. Consult the package repository for your distribution to find out which version is packaged per distribution release. -* {url-alpine}[Alpine Linux (asciidoctor)] -* {url-arch}[Arch Linux (asciidoctor)] -* {url-debian}[Debian (asciidoctor)] -* {url-fedora}[Fedora (asciidoctor)] -* {url-suse}[OpenSUSE (rubygem-asciidoctor)] -* {url-ubuntu}[Ubuntu (asciidoctor)] +* {url-alpine}[Alpine Linux (asciidoctor)^] +* {url-arch}[Arch Linux (asciidoctor)^] +* {url-debian}[Debian (asciidoctor)^] +* {url-fedora}[Fedora (asciidoctor)^] +* {url-suse}[OpenSUSE (rubygem-asciidoctor)^] +* {url-ubuntu}[Ubuntu (asciidoctor)^] If you want to use a version of Asciidoctor that is newer than what is available via your package manager, see xref:ruby-packaging.adoc[]. diff --git a/docs/modules/install/pages/supported-platforms.adoc b/docs/modules/install/pages/supported-platforms.adoc index 789a01d4..3d14e255 100644 --- a/docs/modules/install/pages/supported-platforms.adoc +++ b/docs/modules/install/pages/supported-platforms.adoc @@ -42,4 +42,4 @@ Catalina Windows Server 2019 |=== -Note that while the community tests Asciidoctor on a variety of Linux distributions, it's only officially tested on Ubuntu and Fedora. +While the community tests Asciidoctor on a variety of Linux distributions, it's only officially tested on Ubuntu and Fedora. diff --git a/docs/modules/install/partials/success.adoc b/docs/modules/install/partials/success.adoc index 8ad68700..df70c570 100644 --- a/docs/modules/install/partials/success.adoc +++ b/docs/modules/install/partials/success.adoc @@ -1,4 +1,4 @@ -If the gem installed successfully, its xref:cli:index.adoc[command line interface (CLI)] will be available on your PATH. +If the gem installed successfully, Asciidoctor's xref:cli:index.adoc[command line interface (CLI)] will be available on your PATH. To confirm that Asciidoctor is available, execute: $ asciidoctor --version diff --git a/docs/modules/manpage-backend/pages/index.adoc b/docs/modules/manpage-backend/pages/index.adoc index 346fa25a..72c239d1 100644 --- a/docs/modules/manpage-backend/pages/index.adoc +++ b/docs/modules/manpage-backend/pages/index.adoc @@ -8,6 +8,10 @@ Asciidoctor's built-in man page converter generates {url-man7}[roff-formatted^] manual pages from AsciiDoc documents. +`manpage`:: +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. + == What is a manual page? A manual page, often abbreviated to man page, is a form of software documentation found on Unix-based operating systems. diff --git a/docs/modules/stem/pages/index.adoc b/docs/modules/stem/pages/index.adoc index 756f7fff..4750d463 100644 --- a/docs/modules/stem/pages/index.adoc +++ b/docs/modules/stem/pages/index.adoc @@ -12,7 +12,7 @@ On this page, we look at how STEM expressions are handled when converting AsciiD When a converter comes across a STEM node in an AsciiDoc document, it passes the source of the expression to a STEM processing library, such as MathJax. That library either displays the rendered expression itself (e.g., MathJax), turns it into an image the converter can link to or embed in the output file (e.g., Asciidoctor Mathematical), or translates it into another format that something further down the pipeline can process (e.g., AsciiMath). -The STEM integrations are activated when the `stem` document attribute is set on the document and, if required, the relevant library is installed. +The STEM integrations are activated when the xref:asciidoc:stem:stem.adoc[stem document attribute] is set on the document and, if required, the relevant library is installed. == STEM integrations diff --git a/docs/modules/syntax-highlighting/pages/index.adoc b/docs/modules/syntax-highlighting/pages/index.adoc index ad858d1f..3bdc0e05 100644 --- a/docs/modules/syntax-highlighting/pages/index.adoc +++ b/docs/modules/syntax-highlighting/pages/index.adoc @@ -1,6 +1,6 @@ = Syntax Highlighting -AsciiDoc defines a style of listing block known as a source block for adding a source code listing to a document that's intended to be colorized by a syntax highlighter. +AsciiDoc defines a style of listing block known as a xref:asciidoc:verbatim:source-blocks.adoc[source block] for adding a source code snippets to a document that are intended to be colorized by a syntax highlighter. Here's a simple example of a source block: [source,asciidoc] @@ -18,7 +18,7 @@ Here's how we expect it to appear: puts "Hello, World!" ---- -It's up to an AsciiDoc processor such as Asciidoctor to apply the syntax highlighting to this source block, a process referred to as *source highlighting*. +It's up to an AsciiDoc processor such as Asciidoctor to apply the syntax highlighting to this source block, a process referred to as xref:asciidoc:verbatim:source-highlighter.adoc[source highlighting]. Asciidoctor provides adapters that integrate with several popular syntax highlighter libraries to perform this task. It also provides an interface for implementing a custom syntax highlighter adapter. @@ -27,14 +27,14 @@ It also provides an interface for implementing a custom syntax highlighter adapt Asciidoctor supports two types of syntax highlighters: client-side and build-time. Let's explore each type and how they work. -A *client-side* syntax highlighter performs syntax highlighting in the browser as the page is loading. +A [.term]*client-side syntax highlighter* performs syntax highlighting in the browser as the page is loading. Asciidoctor does not invoke the syntax highlighter itself. Instead, it focuses on adding the assets to the generated HTML so the browser can load the syntax highlighter and run it. For this type of syntax highlighter, Asciidoctor passes the contents of the source block through to the output as is. It also adds metadata to the element so that the syntax highlighter knows to highlight it and which language it is. Unfortunately, Asciidoctor does not process callout numbers in the source block in this case, so they may cause the syntax highlighter to get tripped up. -A *build-time* syntax highlighter performs syntax highlighting during AsciiDoc conversion. +A [.term]*build-time syntax highlighter* performs syntax highlighting during AsciiDoc conversion. Asciidoctor does invoke the syntax highlighter in this case. It also takes care of hiding the callout numbers from the syntax highlighter, ensuring they are put back in the proper place afterwards. What Asciidoctor emits into the output is the result produced by the syntax highlighter, which are the tokens wrapped in `<span>` tags to apply color and other formatting (either inline or via CSS classes). |
