highlightjs-luau

Luau language grammar for programming under the Roblox Platform.

View the Luau language here.

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"
	charset="UTF-8"
	src="/path/to/highlightjs-luau/dist/luau.min.js"></script>
<script type="text/javascript">
	hljs.registerLanguage('luau', hljsDefineLuau);
	hljs.highlightAll();
</script>

Using directly from the UNPKG CDN

<script
	type="text/javascript"
	src="https://unpkg.com/highlightjs-luau/dist/luau.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.

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 file for details. Highlightjs-luau is released under the MIT License. See LICENSE file for details.

Author

Robloxian Demo 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 https://highlightjs.org/.
• The Highlight.js GitHub project: https://github.com/highlightjs/highlight.js.
• Learn more about the Luau language: https://luau-lang.org/why.