https://github.com/anoff/antora-arc42-ui

antora UI bundle for the arc42 template
https://github.com/anoff/antora-arc42-ui

Last synced: 11 months ago
JSON representation

antora UI bundle for the arc42 template

• Host: GitHub
• URL: https://github.com/anoff/antora-arc42-ui
• Owner: anoff
• License: mpl-2.0
• Created: 2019-02-22T21:29:38.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-08-20T14:00:42.000Z (almost 5 years ago)
• Last Synced: 2025-07-10T21:26:36.367Z (about 1 year ago)
• Language: CSS
• Homepage: http://gitarc.xyz
• Size: 3.35 MB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= Antora arc42 UI

:url-opendevise: https://opendevise.com

:url-anoff: https://anoff.io

:url-default-ui: https://gitlab.com/antora/antora-ui-default

image::https://cloud.drone.io/api/badges/anoff/antora-arc42-ui/status.svg[[Build Status, link=https://cloud.drone.io/anoff/antora-arc42-ui]

This is a modified version of the original {url-default-ui}[Antora Default UI bundle]

== Use the UI bundle

[source,yaml,subs=attributes+]

----

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 [.path]_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 (C) 2017-2018.

Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).

See link:LICENSE[] to find the full license text.

== Authors

* Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc]

* {url-anoff}[Andreas Offenhaeuser]