Neo4j Documentation UI

Usage

To use this UI with Antora, add the following configuration to your playbook file:

ui:
  bundle:
    url: https://static-content.neo4j.com/build/ui-bundle-latest.zip

Installation

npm i

Build

To build the UI, run the build command:

npm run build

Preview

You can run a local server to preview the UI by running:

npm start

This will launch a server at http://localhost:5252.

💡	You can configure the port using the environment variable PORT. For instance, if you want to launch the server on port 3000: PORT=3000 npm start

Publish a new UI bundle version

The release process is automated and uses GitHub Actions. See the .github/workflows/release.yml file for details.

The release is performed when a tag is pushed.

1. Use npm version patch (i.e. 0.1.1 → 0.1.2) or npm version minor (i.e. 0.1.1 → 0.2.0) to increase the version in the package.json file and create a tag for the new version. Running these commands will make the changes AND create a commit.

2. Push the tag upstream:

   $ git push --tags origin master

The UI bundle is published to S3. It is available from two URLs:

• https://static-content.neo4j.com/build/ui-bundle-vx.y.z.zip

• https://static-content.neo4j.com/build/ui-bundle-latest.zip

When the tag is pushed, a TC build is triggered, which generates and publishes the latest .css, .js and other assets. If the changes to the bundle include updates to any of the templates in src/layouts or src/partials, each docset needs to be rebuilt with the new bundle and republished for the changes to take effect.