highlightjs / highlightjs-cypher

Cypher language syntax highlighting plugin for highlight.js

Cypher - a language grammar for highlight.js

Cypher is a declarative graph query language created by Neo4j for the graph database management system.

Usage

Simply include the Highlight.js library in your webpage or Node app, then load this module.

Static website or simple usage

Simply load the module after loading Highlight.js. You'll use the minified version found in the dist directory. This module is just a CDN build of the language, so it will register itself as the Javascript is loaded.

<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" charset="UTF-8"
  src="/path/to/highlightjs-cypher/dist/cypher.min.js"></script>
<script type="text/javascript">
  hljs.highlightAll();
</script>

Using directly from the UNPKG CDN

<script type="text/javascript"
  src="https://unpkg.com/highlightjs-cypher/dist/cypher.min.js"></script>

• More info: https://unpkg.com

With Node or another build system

If you're using Node / Webpack / Rollup / Browserify, etc, simply require the language module, then register it with Highlight.js.

var hljs = require('highlightjs');
var hljsCypher = require('highlightjs-cypher');

hljs.registerLanguage("cypher", hljsCypher);
hljs.highlightAll();

React

You need to import both Highlight.js and third-party language like Cypher:

import React, {Component} from 'react'
import 'highlight.js/scss/darcula.scss' # your favourite theme
import cypher from './cypher'
import hljs from 'highlight.js'
hljs.registerLanguage('cypher', cypher);

class Highlighter extends Component
{
  constructor(props)
  {
    super(props);
    hljs.highlightAll();
  }

  render()
  {
    let {children} = this.props;
    return
    {
      <pre ref={(node) => this.node = node}>
        <code className="cypher">
          {children}
        </code>
      </pre>
    }
  }
}

export default Highlighter;

License

Highlight.js is released under the CC0 1.0 License. See LICENSE file for details.

Author

Johannes Wienke [email protected]

Maintainer

Gustavo Reis [email protected]

Links

• The official site for the Highlight.js library is https://highlightjs.org/.
• The Highlight.js GitHub project: https://github.com/highlightjs/highlight.js
• Learn more about Cypher: https://neo4j.com/docs/cypher-manual/current/#cypher-intro