Please add a proper README with usage examples and `dist` build

[joshgoebel]

Users finding your repo from the SUPPORTED_LANGUAGES list will expect to find instructions on how to add your 3rd party grammar to their project.

Please see:

• https://github.com/highlightjs/highlightjs-robots-txt (a example README)
• https://github.com/highlightjs/highlight.js/issues/3008

3008 is specifically related to upgrading from v10 to v11 but it still applies to the proper way to structure your repo to make it easiest to use for the most people.

---

Updated:

This issue is being opened as part of our iniative to make all 3rd party grammars:

• easier to use for all end users
• internally a bit more consistent (both to help end users and also encourage cross-maintenance)
• ready to go for version 11

Please include a dist folder that includes a ready-to-go CDN distributable that can be used with a single line of JS. IE, our simple 3 install should "just work" without any other code or markup:

<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/highlightjs-GN/GN.js"></script>
<script type="text/javascript">hljs.highlightAll();</script>

Your README optimally would also document this usage. Please see the robots-txt repository for a usage example.

• https://github.com/highlightjs/highlightjs-robots-txt#static-website-or-simple-usage

Our build system can generate this file for you (and we recommend that). Using our internal build system also allows you to easily check your grammar for exponential or polynomical run-away regular expressions.

• https://github.com/highlightjs/highlight.js/blob/main/extra/3RD_PARTY_QUICK_START.md#packaging

If you have any questions, feel free to ask!

Thanks, Highlight.js Maintainer

[joshgoebel]

Ping. I've also updated this to be a bit clearer.