Neo4j Graph Academy

neo4j.com/graphacademy

Built with Antora.

• Install Antora

• Standard File and Directory Set

• Module Directories and Modules

Installation

To build these docs locally you will need Node & NPM installed.

To install the dependencies run:

npm install

Live Preview

To preview the docs run:

PORT=3000 npm start

This will build a set of HTML files in build/site and then serve them through an express server at http://localhost:3000. The dev script will also listen for changes and automatically rebuild the files automatically. You’ll still need to refresh the page to view the changes.

Tip

If you want to test the certification pages locally, you will need to disable web security. Otherwise, Marketo won’t submit the form. If you are using Chrome, you can pass the CLI option --disable-web-security when launching Chrome: chrome --disable-web-security In some cases, you might need to specify the --user-data-dir option to disable web security: chrome --user-data-dir="/tmp" --disable-web-security

Publishing

Pushing to the publish branch of this repo will trigger a rebuild of the HTML and CSS files in the Docs Refresh repo using a Github Action.

# clone the repo
git clone https://github.com/neo4j-documentation/graphacademy

# make some changes
touch modules/ROOT/page.adoc

# stage the changes
git add .

# Commit the changes
git commit -m "My changes"

# Merge the latest changes on the remote branch
git pull origin publish

# Push the HEAD of the branch to the publish branch
git push origin HEAD:publish