diff options
Diffstat (limited to 'docs/modules/ROOT/pages/index.adoc')
| -rw-r--r-- | docs/modules/ROOT/pages/index.adoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 359fc24..f4a227e 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -20,7 +20,7 @@ This project produces the {uri-preview}[default UI bundle] for documentation sites generated with {uri-antora}[Antora]. It contains the UI assets (page templates, CSS, JavaScript, images, etc.) and a Gulp build script. -The build can be used to preview the UI locally (featuring live updates), or package it for consumption by the site generator. +The build can be used to preview the UI locally (featuring live updates), or to package it for consumption by the Antora site generator. This documentation explains how to use this project to set up, customize and manage a UI for a documentation site generated with Antora. After reading it, you'll be able to: @@ -184,16 +184,16 @@ Since these optimizations are only applied to the pre-compiled files, they don't The purpose of an Antora UI project is to get the UI files into a state that Antora can use and to make it reusable. The UI is served statically in a production site, but the UI's assets live in a source form in a UI project to accommodate development and simplify maintenance. -When handed off to the Antora generator pipeline, the UI is in an interim, pre-compiled state. +When handed off to the Antora pipeline, the UI is in an interim, pre-compiled state. Specifically, the master branch of the git repository contains the files in source form while releases are used to distribute the files in pre-compiled form. The responsibility of compiling the UI is shared between a UI project and Antora. -The UI project uses a local build to pre-compile (interpret, consolidate, and/or minimize) the files. +The UI project uses a local build to pre-compile (i.e., interpret, consolidate, and/or minimize) the files. The pre-compiled files are agnostic to Antora's content model, relieving the generator from having to deal with this part. It also allows the UI to be reused. The UI project build then packages the UI into a bundle, which the UI Loader in Antora consumes. -Antora grabs the bundle, extracts it into a UI catalog, and finally takes compilation to completion by weaving the content model into the Handlebars templates to make the pages and auxiliary data files. +Antora grabs the bundle, extracts it into a UI catalog, and takes compilation to completion by weaving the Antora's content model into the Handlebars templates to make the pages and auxiliary data files. Antora then copies the remaining UI assets to the site output. -Now that you have a general idea of the files that make up the UI and how it gets assembled, let's go over how to set up the project, build the UI, and preview it. +Now that you have an overview of the files that make up the UI and how it gets assembled, let's go over how to set up the project, build the UI, and preview it. |