highlightjs-magik/README.md

Support for using highlight.js to syntax highlight Magik

# Magik - a language grammar for highlight.js

![version](https://badgen.net/npm/v/highlightjs-magik) ![license](https://badgen.net/badge/license/MIT/blue)
![install size](https://badgen.net/packagephobia/install/highlightjs-magik) ![minified size](https://badgen.net/bundlephobia/min/highlightjs-magik)

[![ci status](https://github.com/sebastiaanspeck/highlightjs-magik/actions/workflows/ci.yml/badge.svg)](https://github.com/sebastiaanspeck/highlightjs-magik/actions/workflows/ci.yml)

## 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
<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/magik.min.js"></script>
<script type="text/javascript">
  hljs.highlightAll();
</script>
```

### Using directly from the UNPKG CDN

```html
<script type="text/javascript"
  src="https://unpkg.com/highlightjs-magik@0.0.2/dist/magik.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.

```javascript
var hljs = require('highlight.js');
var hljsMagik = require('highlightjs-magik');

hljs.registerLanguage("magik", hljsMagik);
hljs.highlightAll();
```

## License

Highlight.js for Magik is released under the MIT License. See [LICENSE][1] file for details.

### Author

Sebastiaan Speck

## Links

- The official site for the Highlight.js library is <https://highlightjs.org/>.
- The Highlight.js GitHub project: <https://github.com/highlightjs/highlight.js>

[1]: https://github.com/sebastiaanspeck/highlightjs-magik/blob/main/LICENSE