Antora Default UI

This project modify the Antora archetype, to build documentations for PCI Studio.

Use the UI

To use this UI with Antora, add the following configuration to your playbook file:

ui:
  bundle:
    url: {url-project}/releases/download/{current-release}/ui-bundle.zip
    snapshot: true

Note	github.com/pcistudio/doc-site-ui/releases/download/v0.22/ui-bundle.zip

Build and preview the UI locally

Prerequisites

To preview and bundle the default UI, you need the following software on your computer:

• git (command: git)

• Node.js (commands: node and npm)

• Gulp CLI (command: gulp)

Note	If Need a detail guide of who to build and preview the UI, please refer to the original Antora UI guide. Antora UI Building Guide

If you have the prerequisites installed, you can build and preview the UI by following these steps:

1. Clone the repository:

2. Run this commans

npm install
gulp preview

The gulp preview command will build the UI and start a local web server that serves the UI. You can view the UI by opening a web browser and navigating to localhost:5252.

Package for Use with Antora

If you make changes to the UI and want to package it for use with Antora, run the following command:

$ gulp bundle

And then you can see the generated ui-bundle.zip file in the build directory.

Learn More

A more comprehensive tutorial can be found in the documentation at docs.antora.org.