This is an unversioned repo with folders to the different content that will be built with Antora.

Each directory will have a antora.yml file with configuration, then the start_path in antora-playbook.yml will define which subfolder is picked up.

In order to build the content,

The npm install command will install Antora CLI, which is then used to build the content defined in the Antora Playbooks (*.yml files in the project root).

To build the content, run the build command:

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

This will launch a server at http://localhost:8000/

Any changes to the master branch will trigger an automatic rebuild of all content using Github Actions. The action runs the npm run build command which builds the following playbooks using the Antora CLI:

• unversioned.yml - Developer guides at neo4j.com/developer/ and Labs pages at neo4j.com/labs/

• labs-docs.yml - Builds the documentation from remote sources into neo4j.com/labs/{project}/{version}

• Helm

• APOC

• Neosemantics

• Neo4j Streams/Kafka

• Helm

• ETL Tool

The HTML files built by the build command are uploaded to the static-content.neo4j.com S3 Bucket, where it is synced hourly with the neo4j.com server. The cronjob runs on the hour, every hour so it may take up to an hour for the content to become live.

For more information on specific theme features, clone the Documentation Starter and run npm start.