README.md

High-level shader language (HLSL) - a language grammar for highlight.js

Demo

The below screenshot was captured from the demo webpage.

Usage

Simply include the Highlight.js library in your webpage, then load this module.

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/highlightjs-hlsl/dist/hlsl.min.js"
></script>
<link rel="stylesheet" href="/path/to/highlightjs/styles/default.min.css" />
<script type="text/javascript">
  hljs.highlightAll();
</script>

For more details of the usage see Highlight.js main page.

Authors

Stef Levesque

Contribution

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

A good starting point for how to build and test your changes locally is here.

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 HLSL: https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl