/antora-arc42-ui

antora UI bundle for the arc42 template

Primary LanguageCSSMozilla Public License 2.0MPL-2.0

Antora arc42 UI

[Build Status

This is a modified version of the original Antora Default UI bundle

Use the UI bundle

ui:
  bundle:
    url: https://github.com/anoff/antora-arc42-ui/releases/download/0.2/ui-bundle.zip
    # see https://github.com/anoff/antora-arc42-ui/releases/latest for latest version

Usage

Install required dependencies

$ npm install
$ npm install -g gulp-cli

Preview the UI

To build the UI and preview it in a local web server, run the preview command:

$ gulp preview

Package for Use with Antora

If you need to bundle the UI in order to preview the UI on the real site in local development, run the following command:

$ gulp bundle

The UI bundle will be available at build/ui-bundle.zip. You can then point Antora at this bundle using the --ui-bundle-url command-line option.

Copyright and License

Based on the work of OpenDevise Inc. and the Antora Project Copyright © 2017-2018.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to find the full license text.

Authors