rossbowen/highlightjs-turtle

Highlighting for the Turtle and SPARQL semantic web languages

highlightjs-turtle

highlight.js syntax definitions for these semantic web languages:

• Turtle 1.1
• SPARQL 1.1: Query and Update languages (see BNF grammar and syntax diagrams)
• GraphDB Rules (PIE)
• SHACL Compact (see BNF grammar and syntax diagrams) (still in TODO)

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" src="/path/to/pie.min.js"></script>
<script type="text/javascript" src="/path/to/turtle.min.js"></script>
<script type="text/javascript" src="/path/to/sparql.min.js"></script>
<script type="text/javascript">
  hljs.highlightAll();
</script>

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('highlight.js');
const { pieGrammar, sparqlGrammar, turtleGrammar } = require("highlightjs-turtle");

hljs.registerLanguage('pie', pieGrammar);
hljs.registerLanguage('sparql', sparqlGrammar);
hljs.registerLanguage('turtle', turtleGrammar);

Links

• http://highlightjs.org for more info on highlight.js and a live demo
• highlightjs-shexc for another semantic language, SHEX (Shape Expressions)
• highlight-to-reveal for info about using this in reveal.js, a tool for web-based presentations (NOTE: this is outdated!)

Contributors

• Mark Ellis, @ellismarkf, Stardog Union
• Vladimir Alexiev, @VladimirAlexiev, Ontotext Corp