https://github.com/highlightjs/highlightjs-cypher

Cypher language syntax highlighting plugin for highlight.js
https://github.com/highlightjs/highlightjs-cypher

cypher highlight highlight-js highlightjs neo4j

Last synced: 3 months ago
JSON representation

Cypher language syntax highlighting plugin for highlight.js

• Host: GitHub
• URL: https://github.com/highlightjs/highlightjs-cypher
• Owner: highlightjs
• License: cc0-1.0
• Created: 2019-02-17T10:30:17.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T07:47:01.000Z (about 1 year ago)
• Last Synced: 2024-04-25T16:03:17.110Z (9 months ago)
• Topics: cypher, highlight, highlight-js, highlightjs, neo4j
• Language: JavaScript
• Homepage: https://highlight.js
• Size: 83 KB
• Stars: 11
• Watchers: 6
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![logo](logo.svg)

# Cypher - a language grammar for [highlight.js](https://highlightjs.org/)

![version](https://badgen.net/npm/v/highlightjs-cypher) ![license](https://badgen.net/badge/license/CC0%201.0/blue)

![install size](https://badgen.net/packagephobia/install/highlightjs-cypher) ![minified size](https://badgen.net/bundlephobia/min/highlightjs-cypher)

[![Build Status](https://travis-ci.com/highlightjs/highlightjs-cypher.svg?branch=master)](https://travis-ci.com/highlightjs/highlightjs-cypher)

Cypher is a declarative graph query language created by [Neo4j](https://neo4j.com/) 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.

```html

  hljs.highlightAll();

```

### Using directly from the UNPKG CDN

```html

```

- More info: 

### 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.

```javascript

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:

```js

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

    {

      
 this.node = node}>

        

          {children}

        

      

    }

  }

}


export default Highlighter;

```

## License

Highlight.js is released under the CC0 1.0 License. See [LICENSE][1] file

for details.

### Author

Johannes Wienke 

### Maintainer

Gustavo Reis 

## Links

- The official site for the Highlight.js library is .

- The Highlight.js GitHub project: 

- Learn more about Cypher: 

[1]: https://github.com/highlightjs/highlightjs-cypher/blob/master/LICENSE