Code Monkey home page Code Monkey logo

aas-specs-antora-ui's Introduction

aas-specs-antora-ui

Description

This repository contains the source files of the User Interface bundle that is meant to be used by Antora to generate the documentation website for all specifications of the Asset Administration Shell, i.e. for all repositories that are AAS Specifications. The build and deployment of the site takes place in the repository aas-specs-antora. This UI Bundle is based off of Antora Default UI.

Please note that this repository is currently in active development.

Prerequisites

Before proceeding, you are required to have the latest Node.js LTS release installed on your Linux, Windows, or macOS machine. You can then follow the steps 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 Antora Default UI. Complying with their original License, this project is under the Mozilla Public License 2.0. See the LICENSE file for details.

aas-specs-antora-ui's People

Contributors

zrgt avatar monsieuremre avatar github-actions[bot] avatar birgitboss avatar

Forkers

rwth-iat

aas-specs-antora-ui's Issues

Copyright notice - Update name

The copyright notice of the UI still is marked as ?not sure?. Should this better be replaced with Industrial Digital Twin Association as the copyright holder of the content? This is the notice at the bottom when someone scrolls down.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.