Preview

You create a GraphGist by creating a GitHub Gist in AsciiDoc and enter the URL to it in the form on this page. Alternatively, you can put an AsciiDoc document in Dropbox and enter the public URL in the form.

This GraphGist shows the basics of using AsciiDoc syntax and a few additions for GraphGists. The additions are entered as comments on their own line. They are: //console for a query console; //hide, //setup and //output to configure a query; //graph and //table to visualize queries and show a result table.

Click on the Page Source button in the menu to see the source for this GraphGist. Read below to get the full details.

Include a query console

//console

becomes:

Running queries, preparing the console!

Define a Cypher query

[source,cypher]
----
CREATE (n{name:'cypher'})-[r:LIKES]->({name:'icecream'})
RETURN n.name, r
----

becomes:

CREATE (n{name:'cypher'})-[r:LIKES]->({name:'icecream'})
RETURN n.name, r

Queries are executed in the order they appear on the page during rendering, so make sure they can be performed in that order. Each query has a green or red button to indicate if the query was successful or not. The console is set up after the executions, with an empty database, for the reader to play around with the queries.

There’s three additional settings you can use for queries. They all go as comments, on their own lines, before the query. The settings are:

hide

Hide the query. The reader can still expand it to see it. Useful for long queries like setting up initial data.

setup

Initialize the console with this query.

output

Show the output from the query. The output is always there, but this option makes it visible at page load for this query.

Let’s try all the settings together, which means this query will be used to initialize the console, it will be hidden, and the raw output will be shown:

//hide
//setup
//output
[source,cypher]
----
CREATE (n{name:'neo4j'})-[:LIKES]->({name:'complex data'})
RETURN n.name
----

which becomes:

CREATE (n{name:'neo4j'})-[:LIKES]->({name:'complex data'})
RETURN n.name
Note
The test run will always run the queries from top to bottom, so it usually makes sense to have the setup query as the first query.

Show a graph visualization

The visualization is based on the database contents after the preceding query in the page.

//graph

becomes:

Loading graph...

Show a result table for a query

This will show a result table for the preceding query.

//table

becomes:

Loading table...

Query with error

This is what happens if a query causes an error:

CREATE (n{name:'cypher'}

Basic AsciiDoc formatting

_Italic_

Italic

*Bold*

Bold

`Monospace`

Monospace

http://www.neo4j.org/

neo4j.org

Link to a GraphGist

Headings:

= Heading 1
== Heading 2
=== Heading 3

Images:

image::http://assets.neo4j.org/img/still/cineasts.gif[]
* Item 1
** Item 1.1
* Item 2
  • Item 1

    • Item 1.1

  • Item 2

. First
. Second
  1. First

  2. Second

Monospaced block: indent lines with one space.

Tables are well supported. See AsciiDoc Quick Reference for information on that and more.