highlightjs-juvix

Juvix support for Highlight.js

Usage

Simply include the Highlight.js library in your webpage or Node app, then load this module. For more complex usage, see highlight.js usage.

Static website or simple usage

Simply load this 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/juvix.min.js"></script>
<!-- Use any stylesheet you'd like - though it's best to choose from 
	those in highlightjs core repo -->
<link rel="stylesheet" href="https://unpkg.com/highlightjs/styles/vs.css" />
<script type="text/javascript">
  hljs.registerLanguage('juvix', hljsDefineJuvix);
  hljs.registerLanguage('jrepl', hljsDefineJuvixRepl);
  hljs.highlightAll();
</script>

This will find and highlight code inside <pre><code> tags; it tries to detect the language automatically. If automatic detection doesn’t work for you, you can specify the language in the class attribute:

<pre>
    <code class="language-juvix">
      module HelloWorld;
      open import Stdlib.Prelude;
      main : IO;
      main := printStringLn "hello world!";
    </code>
</pre>

In case you want to highlight sessions with the Juvix REPL, you can use the following.

<pre><code class="language-jrepl">
      Stdlib.Prelude> --example of a comment
      Stdlib.Prelude> 3 + 4
    </code></pre>

For more details see Highlight.js main page.

Using directly from jsDelivr

<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release/build/highlight.min.js"></script>
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/highlightjs-juvix/dist/juvix.min.js"></script>

• More info: https://www.jsdelivr.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 hljsJuvix = require('highlightjs-juvix');

hljs.registerLanguage('juvix', hljsJuvix);
hljs.highlightAll();

MDBOOK integration

Unfortunately, Mdbook does not support the latest version of Highlight.js and uses the outdated version 10.1.0. As Mdbook is utilized for documenting Juvix, we have provided a custom Juvix language module tailored for this specific version of Highlight.js. To use it, replace juvix.min.js with juvix-mdbook.min.js. You can find this file in the dist directory, or you can use the CDN link.

To proceed, you must edit the theme/index.hbs file and include the import of the juvix-mdbook.min.js file. Ensure that it is placed between the imports of highlight.js and book.hs, along with the language registration as demonstrated below:

<script src="{{ path_to_root }}highlight.js"></script>
<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/highlightjs-juvix/dist/juvix-mdbook.min.js"></script>
<script>
  hljs.registerLanguage('juvix', hljsDefineJuvix);
  hljs.registerLanguage('jrepl', hljsDefineJuvixRepl);
</script>
<script src="{{ path_to_root }}book.js"></script>

Once the necessary changes have been made, you can utilize the Juvix language in your markdown files as shown below:

```juvix
module HelloWorld;
open import Stdlib.Prelude;
main : IO;
main := printStringLn "hello world!";
```

In case you want to highlight sessions with the Juvix REPL, you can use the following.

```jrepl
Stdlib.Prelude> --example of a comment
Stdlib.Prelude> 3 + 4
```

License

Highlight.js is released under the BSD 3-Clause License. See LICENSE file for details. Highlightjs-juvix is released under the MIT License. See LICENSE file for details.

Contribution

Feel free to create issues and pull requests to improve this package.

Links

• Learn more about Juvix: https://juvix.org/
• The official site for the Highlight.js library is https://highlightjs.org/.
• The Highlight.js GitHub project: https://github.com/highlightjs/highlight.js