Neo4j Documentation Starter

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:

npm start

This will build a set of HTML files in build/site and then serve them through an express server at http://localhost:8000. 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.

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/developer-guides

# 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 master

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