Converting Asciidoc Files to Neo4j Browser Guides

This program uses AsciiDoctor erb templates to generate an outline html and a slide for each level two header.

Create HTML

./run.sh path/to/a_guide.adoc [guide.html]

-> html/a_guide.html

Full options:

./run.sh /path/to/file.adoc [/path/to/file.html] [header-level-offset] [base-url] [additional asciidoc options]

# for example for the recommendations sandbox-guide
./run.sh ../recommendations/documentation/recommendations.adoc \
         ../recommendations/documentation/recommendations.neo4j-browser-guide \
         +1 https://guides.neo4j.com/sandbox/recommendations -a neo4j-version=5.4 -a env-guide

Start Local Server

It is patched to allow CORS headers for the browser to serve the HTML directory.

python http-server.py &

Configuration

• before Neo4j 3.0 add dbms.browser.remote_content_hostname_whitelist=* to conf/neo4j-server.properties

• from Neo4j 3.0 add browser.remote_content_hostname_whitelist=* to conf/neo4j.conf

and restart. You can also add the specific localhost:8001 address.

For neo4j-community you have to use sudo and run the http script on port 80. For example, use BaseHTTPServer.HTTPServer(("0.0.0.0", 80),CORSRequestHandler).serve_forever() in http.py

To view the guides in the Neo4j Browser, run:

:play http://localhost:8001/html/a_guide.html

You can find more details on how to create guides and their format in docs/remote-guides.md and an example in docs/remote.html