npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

highlightjs-juvix

v0.1.1

Published

Juvix language grammars for HightlightJS

Downloads

3

Readme

Juvix support for Highlight.js

GitHub

NPM Version

CDN download

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>

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:

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

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