diff options
| author | Sarah White <graphitefriction@gmail.com> | 2018-01-10 19:11:59 -0700 |
|---|---|---|
| committer | Sarah White <graphitefriction@gmail.com> | 2018-01-10 19:11:59 -0700 |
| commit | e7c23d0f820f316c8745ed947ba4890354b749cf (patch) | |
| tree | 19313ffea89f5dfbede6aa6c8daf5882da0e8a9d /README.adoc | |
| parent | 1e6f6233a2512764c8dfbec02874210f20472acb (diff) | |
| download | alpine-antora-theme-e7c23d0f820f316c8745ed947ba4890354b749cf.tar.bz2 alpine-antora-theme-e7c23d0f820f316c8745ed947ba4890354b749cf.tar.xz | |
minor copyedits to README and docs
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/README.adoc b/README.adoc index 16e1d7e..8133049 100644 --- a/README.adoc +++ b/README.adoc @@ -21,11 +21,11 @@ image:{img-ci-status}[CI Status (GitLab CI), link={uri-ci-pipelines}] This project is an archetype that demonstrates how to produce a UI bundle for use in a documentation site generated with {uri-antora}[Antora]. -You can see a preview the default UI at {uri-preview}. +You can see a preview of the default UI at {uri-preview}. -== Using the Default UI +== Use the Default UI -If you want to use the default UI for your Antora-based site, add the following UI configuration to your playbook: +If you want to use the default UI for your Antora-generated site, add the following UI configuration to your playbook: [source,yaml,subs=attributes+] ---- @@ -94,7 +94,7 @@ You should install the Gulp CLI globally (which resolves to a location in your u ==== Yarn -Finally, you will need Yarn, which is the preferred package manager for the Node ecosystem. +Finally, you'll need Yarn, which is the preferred package manager for the Node ecosystem. You should install Yarn globally (which resolves to a location in your user directory if you're using nvm) using the following command: @@ -102,7 +102,7 @@ You should install Yarn globally (which resolves to a location in your user dire Now that you have the prerequisites installed, you can fetch and build the default UI project. -=== Cloning and Initializing the Project +=== Clone and Initialize the UI Project Clone the default UI project using git: @@ -113,7 +113,7 @@ Clone the default UI project using git: The example above clones Antora's default UI project and then switches to the project folder on your filesystem. Stay in this project folder in order to initialize the project using Yarn. -You'll use Yarn to install the project's dependencies. +Use Yarn to install the project's dependencies. In your terminal, execute the following command (while inside the project folder): $ yarn install @@ -121,7 +121,7 @@ In your terminal, execute the following command (while inside the project folder This command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project. This folder does not get included in the UI bundle. -=== Previewing the UI +=== Preview the UI The default UI project is configured to preview offline. That's what the files in the [.path]_preview-site-src/_ folder are for. @@ -150,7 +150,7 @@ This works by monitoring the project for changes, running the `build` task if a Press kbd:[Ctrl+C] to stop the preview server and end the continuous build. -=== Packaging for Use with Antora +=== Package for Use with Antora If you need to package the UI in order to preview the UI on the real site in local development, run the following command: |