This repository contains the AsciiDoc and other sources to build the Neo4j Java Reference.
To build these docs locally you will need Node & NPM installed.
To install the dependencies run:
npm install
To preview the docs, run:
npm run 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 start script will also listen for changes and automatically rebuild the files automatically.
You will still need to refresh the page to view the changes.
To make changes to this repository, please create a fork of this repo and a new branch to stage your changes.
Your branch should be prefixed with the version number, for example 5.0-feature-to-document
.
When you are finished with your changes push the branch to your fork and create a Pull Request. Please add at least one approver.