cancel
Showing results for 
Search instead for 
Did you mean: 

Help please with creating a neo4j guide

nawar_alwesh
Node Clone

Hi 

I followed the instructions on how to create a guide from

https://neo4j.com/developer/guide-create-neo4j-browser-guide/

I got the guide repository  https://github.com/neo4j-contrib/neo4j-guides

But when I run ./run.sh adoc/restaurant_recommendation.html.adoc html/test.html

and open the guide in neo4j browser I get the whole thing in one page (ie not different slides), the code is not clickable. The output I get doesn't match the downloaded

restaurant_recommendation.html. 
Would really appreciate any help on what I am doing wrong and how to fix it?
 
Thanks

 

2 REPLIES 2

luiseduardo
Ninja
Ninja

Hi @nawar_alwesh !

I think you can start with the beginning before using these tools, which do a great job to automate most of the dirty work! This is an example that I have from the paysim database:

<html>
	<slide>
		<h3>Preliminary Data Analysis</h3>
		<p>We will use Paysim dataset for the hands-on exercises. Paysim is a synthetic dataset that mimics real world mobile money transfer network.</p>

		<p>Let’s explore the dataset.</p>

		<p>Database Schema and Stats</p>
		<pre class="code runnable">
			CALL db.schema.visualization();
		</pre>
		<p>Nodes and Relationships</p>
		<pre class="code runnable">
			CALL apoc.meta.stats();
		</pre>
	</slide>
</html>

First, the entire guide is enclosed by html tags. Every card with text or queries is separated by slide tags, here you can put images, videos, etc. with the corresponding tags. In this case, I also add header and paragraph tags to make it a bit more stylish. Those pre tags with class code runnable allow the text to be executable in browser.

I'd suggest to check your file (I tend to use neo4j-browser-guide as the extension for these) and see if it has the same structure. If not, maybe one of the steps wasn't done correctly. You can test your guide in Neo4j Desktop, by adding the file to your project, just drag the file into the File section, or copy them into the folder by your file manager. You should see them like this:

luiseduardo_1-1665185481306.png

If you click the Open button, a Neo4j Browser starts up with the guide within it.

Hope this helps!

 

nawar_alwesh
Node Clone

Thanks for your reply, that's what i ended up doing, just writing the html file myself. However i was really hoping to use the the asciidoc in the run shell script to convert adoc to html. Just wondering why it didn't work for me?

Nodes 2022
Nodes
NODES 2022, Neo4j Online Education Summit

On November 16 and 17 for 24 hours across all timezones, you’ll learn about best practices for beginners and experts alike.