https://github.com/blackbelttechnology/judo-community-documentation

https://github.com/blackbelttechnology/judo-community-documentation

documentation judo low-code toolbox

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/blackbelttechnology/judo-community-documentation
• Owner: BlackBeltTechnology
• Created: 2022-07-25T14:11:45.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2024-11-19T20:34:05.000Z (about 2 months ago)
• Last Synced: 2024-11-19T21:29:49.986Z (about 2 months ago)
• Topics: documentation, judo, low-code, toolbox
• Language: CSS
• Homepage: https://documentation.judo.technology
• Size: 2.51 MB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • Contributing: CONTRIBUTING.adoc

Awesome Lists containing this project

README

        
# JUDO Community Documentation

*The build process does not work when ran inside git-submodules:*

https://gitlab.com/antora/antora/-/issues/895

_(Please check out the project separately)_

## Build Documentation

> Certain Antora Modules are pulled in from different Maven artifacts

```bash

mvn clean install

```

## Build UI

The `ui` folder contains the theming of the documentation and it's source code.

By default the `mvn clean install` command runs the build process for it, but it is not mandatory if we are only working

on the docs, and not the theme.

**IMPORTANT!**

The entry `build/index.html` file is copied by the `maven-resources-plugin` from `src/main/resources`.

This file is necessary because for multi version documentations, Antora explicitly generates "Components", which are

sub-folders under `build`.

Antora does not generate any entry file "above" component folders, therefore we need to take care about it.

**Ignoring ui builds:**

```bash

mvn clean install -DskipBuildUI

```

### Customize JSL Highlighting

* ui/src/css/highlight.css

* ui/src/js/vendor/highlight.bundle.js