Skip to content

README.adoc

Latest commit

 

History

History
80 lines (51 loc) · 2.96 KB

README.adoc

File metadata and controls

80 lines (51 loc) · 2.96 KB
Raw

Operations manual

Prereqs

Installation

To install the required packages:

npm i

Generating HTML output

To convert asciidoc source to HTML:

npm run build

Viewing HTML output

To view the built site, launch a local server:

  1. npm start

  2. In a browser tab, go to localhost:8000

Live preview

When you run npm start, the project is monitored for updates to asciidoc files.

If a change to an asciidoc file is detected the site is automatically rebuilt.

Raise a PR

For changes to the latest documentation version, open a PR against the dev branch. The Docs team will cherry-pick your changes to the main branch for publication.

To update documentation for another Neo4j version, open a PR against the corresponding branch:

  • 5.x for Neo4j 5.x.

  • 4.4 for Neo4j 4.4.