aas-specs-antora-ui

Description

This repository contains the source files of the User Interface bundle that is meant to be used by https://antora.org/[Antora] to generate the documentation website for all specifications of the https://github.com/admin-shell-io/[Asset Administration Shell], i.e. for https://github.com/orgs/admin-shell-io/repositories/[all repositories] that are AAS Specifications. The build and deployment of the site takes place in the repository https://github.com/rwth-iat/aas-specs-antora/[aas-specs-antora]. This UI Bundle is based off of https://gitlab.com/antora/antora-ui-default/[Antora Default UI].

Please note that this repository is currently in active development.

Prerequisites

Before proceeding, you are required to have the latest https://nodejs.org/en/download/[Node.js LTS release] installed on your Linux, Windows, or macOS machine. You can then follow the steps https://docs.antora.org/antora/latest/install/install-antora/[here] to install Antora and set it up to use this bundle with it.

Building

In order to locally build the documentation website on your own, you have to make sure you have Antora CLI installed on your machine first. You can then continue with cloning this repository. First, you have to install the dependencies. For this, run

npm i

This is short for npm install. It will install the dependencies listed in package.json into the node_modules/ folder inside the project.

To build the UI once for preview, run the following:

npx gulp preview:build

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

npx gulp bundle

The generated website should appear under build/ui-bundle.zip.

License

This project is a fork of https://gitlab.com/antora/antora-ui-default/[Antora Default UI]. Complying with their original License, this project is under the Mozilla Public License 2.0. See the https://github.com/admin-shell-io/aas-specs-antora-ui/blob/main/LICENSE/[LICENSE] file for details.