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

Highlight.js grammar for Luau (for Roblox)
https://github.com/highlightjs/highlightjs-luau

Last synced: 5 months ago
JSON representation

Highlight.js grammar for Luau (for Roblox)

• Host: GitHub
• URL: https://github.com/highlightjs/highlightjs-luau
• Owner: highlightjs
• License: mit
• Created: 2023-11-11T00:29:45.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-09T14:41:58.000Z (about 2 years ago)
• Last Synced: 2024-06-12T16:37:59.700Z (about 2 years ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


# Luau Language Grammar for highlight.js

[Luau](https://luau.org) is a fast, small, safe, gradually typed embeddable scripting language derived from Lua.

[![NPM](https://nodei.co/npm/highlightjs-luau.png)](https://www.npmjs.com/package/highlightjs-luau)

[![npm](https://img.shields.io/npm/v/highlightjs-luau)](https://www.npmjs.com/package/highlightjs-luau)

[![npm](https://img.shields.io/npm/dt/highlightjs-luau)](https://www.npmjs.com/package/highlightjs-luau)

![install size](https://badgen.net/packagephobia/install/highlightjs-luau)

[![GitHub](https://img.shields.io/github/license/highlightjs/highlightjs-luau)](https://github.com/highlightjs/highlightjs-luau/blob/main/LICENSE.md)

![Snyk Vulnerabilities for npm package](https://img.shields.io/snyk/vulnerabilities/npm/highlightjs-luau)

[![CDN download](https://badgen.net/badge/jsDelivr/download/blue?icon=jsdelivr)](https://cdn.jsdelivr.net/npm/highlightjs-luau/dist/luau.min.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](https://github.com/highlightjs/highlight.js#basic-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.

```html

	hljs.registerLanguage('luau', hljsDefineLuau);

	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 hljsLuau = require('highlightjs-luau');

hljs.registerLanguage('luau', hljsLuau);

hljs.highlightAll();

```

## License

Highlight.js is released under the BSD 3-Clause License. See [LICENSE](https://github.com/highlightjs/highlight.js/blob/main/LICENSE) file for details.

Highlightjs-luau is released under the MIT License. See [LICENSE](/LICENSE.md) file for details.

## Author

Robloxian Demo [https://github.com/RobloxianDemo](https://github.com/RobloxianDemo).

## Contribution

Feel free to create issues or (even better) pull requests.

## Links

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

- The Highlight.js GitHub project: .

- Learn more about the Luau language: .