diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2024-02-04 16:10:41 -0700 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2024-02-04 16:10:41 -0700 |
| commit | 34bc388341b470bf0290b0b0f9efd67b192460da (patch) | |
| tree | d3200080d1a3c413b975b091a088b36e20fe9eb2 /docs/modules/html-backend | |
| parent | 5cfd8adfdae60ca1168315a78999c80610c91568 (diff) | |
rework the backend and converter sections for each of the built-in converters
Diffstat (limited to 'docs/modules/html-backend')
| -rw-r--r-- | docs/modules/html-backend/pages/index.adoc | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/docs/modules/html-backend/pages/index.adoc b/docs/modules/html-backend/pages/index.adoc index 0bef296c..1de65ff6 100644 --- a/docs/modules/html-backend/pages/index.adoc +++ b/docs/modules/html-backend/pages/index.adoc @@ -1,11 +1,21 @@ = Generate HTML from AsciiDoc :navtitle: Generate HTML -== HTML 5 converter +Asciidoctor's default output format is HTML (specifically HTML 5). +That means when you run Asciidoctor without any parameters, it will produce HTML. +This page explains how to use Asciidoctor to convert AsciiDoc to HTML. -Asciidoctor's default output format is HTML. +== Backend and converter -`html`:: The HTML 5 converter (`html` or `html5`) generates HTML 5 styled with CSS3. +Asciidoctor's built-in HTML converter is registered for the `html` and `html5` backends. +The HTML converter generates HTML 5 that's styled with CSS3. +It may include JavaScript to support additional integrations, such as client-side syntax highlighting. + +[horizontal] +Backend names:: `html`, `html5` +Converter class:: `Asciidoctor::Converter::Html5Converter` +Output format:: HTML +Output file extension:: .html WARNING: A standalone HTML document generated by the built-in HTML converter loads web fonts from Google Fonts, which are then referenced by the default stylesheet. The xref:default-stylesheet.adoc[default stylesheet] makes use of web fonts to ensure the document renders consistently across platforms. @@ -14,7 +24,9 @@ If this presents a problem, you can xref:default-stylesheet.adoc#disable-or-modi When this is done, the default stylesheet reverts to using generic font families (e.g., sans-serif), which are mapped to system fonts by your browser. The consequence is that the appearance of the document will be different and system dependent due to a reliance on system fonts. -== Generate HTML using the html5 converter +If the backend name is prefixed with `x` (e.g., `xhtml`), the converter will <<xhtml,generate XHTML>>, the XML variant of HTML. + +== Generate HTML In this section, we'll create a sample document, then process and convert it with Asciidoctor's built-in HTML converter. @@ -72,8 +84,11 @@ As a result, you could save [.path]_my-document.html_ to any computer and it wil [#xhtml] == Generate XHTML -`xhtml`:: The XHTML variant of the HTML 5 converter. -To use the XHTML converter, assign `xhtml` or `xhtml5` to the `backend` option. +[horizontal] +Backend names:: `xhtml`, `xhtml5` +Converter class:: `Asciidoctor::Converter::Html5Converter` +Output format:: XML variant of HTML +Output file extension:: .html .Produce XHTML using the xhtml5 backend option $ asciidoctor -b xhtml5 my-document.adoc |
